Tài liệu tham khảo GPT

Tài liệu tham khảo này sử dụng ký hiệu TypeScript để mô tả các loại. Bảng sau đây đưa ra một lời giải thích ngắn gọn bằng ví dụ.

Biểu thức kiểu
string	Loại chuỗi nguyên thuỷ.
string[]	Một loại mảng, trong đó các giá trị chỉ có thể là chuỗi.
number | string	Một loại hợp nhất, trong đó giá trị có thể là số hoặc chuỗi.
Array<number | string>	Một loại mảng, trong đó các giá trị là một loại phức tạp (hợp nhất).
[number, string]	Một loại bộ giá trị, trong đó giá trị là một mảng gồm hai phần tử phải chứa một số và một chuỗi theo thứ tự đó.
Slot	Một loại đối tượng, trong đó giá trị là một thực thể của googletag.Slot.
() => void	Một kiểu hàm không có đối số được xác định và không có giá trị trả về.

Để tìm hiểu thêm về các loại và biểu thức loại được hỗ trợ, hãy tham khảo Sổ tay TypeScript .

Chú thích kiểu dữ liệu

Dấu hai chấm sau một biến, tên tham số, tên thuộc tính hoặc chữ ký hàm biểu thị một chú giải kiểu. Chú thích kiểu mô tả các kiểu mà phần tử ở bên trái dấu hai chấm có thể chấp nhận hoặc trả về. Bảng sau đây cho thấy ví dụ về chú thích kiểu mà bạn có thể thấy trong tài liệu tham khảo này.

Chú thích kiểu
param: string	Cho biết rằng param chấp nhận hoặc trả về một giá trị chuỗi. Cú pháp này được dùng cho các biến, tham số, thuộc tính và kiểu dữ liệu trả về.
param?: number | string	Cho biết rằng param là không bắt buộc, nhưng chấp nhận số hoặc chuỗi khi được chỉ định. Cú pháp này được dùng cho các thông số và thuộc tính.
...params: Array<() => void>	Cho biết rằng params là một tham số còn lại chấp nhận các hàm. Tham số còn lại chấp nhận một số lượng giá trị không giới hạn thuộc loại được chỉ định.

---

googletag

Vùng chứa tên chung mà Thẻ nhà xuất bản của Google dùng cho API của thẻ.

Không gian tên
config	Giao diện cấu hình chính cho chế độ cài đặt cấp trang.
enums	Đây là không gian tên mà GPT sử dụng cho các loại enum.
events	Đây là không gian tên mà GPT dùng cho Sự kiện.
secureSignals	Đây là không gian tên mà GPT dùng để quản lý tín hiệu an toàn.

Giao diện
CommandArray	Mảng lệnh chấp nhận một chuỗi các hàm và gọi chúng theo thứ tự.
CompanionAdsService	Dịch vụ Quảng cáo đồng hành.
PrivacySettingsConfig	Đối tượng cấu hình cho chế độ cài đặt quyền riêng tư.
PubAdsService	Dịch vụ Quảng cáo của nhà xuất bản.
ResponseInformation	Một đối tượng đại diện cho một phản hồi quảng cáo.
RewardedPayload	Một đối tượng đại diện cho phần thưởng liên kết với một quảng cáo có tặng thưởng.
Service	Lớp dịch vụ cơ sở chứa các phương thức chung cho tất cả các dịch vụ.
SizeMappingBuilder	Trình tạo cho các đối tượng chỉ định ánh xạ kích thước.
Slot	Vùng quảng cáo là một đối tượng đại diện cho một vùng quảng cáo duy nhất trên một trang.

Bí danh loại
GeneralSize	Một cấu hình kích thước hợp lệ cho một vị trí, có thể là một hoặc nhiều kích thước.
MultiSize	Danh sách các kích thước hợp lệ riêng lẻ.
NamedSize	Các kích thước được đặt tên mà một vùng quảng cáo có thể có.
SingleSize	Một kích thước hợp lệ duy nhất cho một vị trí.
SingleSizeArray	Mảng gồm 2 số biểu thị [chiều rộng, chiều cao].
SizeMapping	Một mối liên kết giữa kích thước khung hiển thị và kích thước quảng cáo.
SizeMappingArray	Danh sách các mối liên kết kích thước.

Biến
apiReady	Cờ cho biết API GPT đã được tải và sẵn sàng được gọi.
cmd	Tham chiếu đến hàng đợi lệnh chung để thực thi không đồng bộ các lệnh gọi liên quan đến GPT.
pubadsReady	Cờ cho biết PubAdsService đã được bật, tải và hoạt động đầy đủ.
secureSignalProviders	Tham chiếu đến mảng nhà cung cấp tín hiệu an toàn.

Hàm
companionAds	Trả về một tham chiếu đến CompanionAdsService.
defineOutOfPageSlot	Tạo một vùng quảng cáo nằm ngoài trang bằng đường dẫn đơn vị quảng cáo nhất định.
defineSlot	Tạo một vùng quảng cáo có đường dẫn và kích thước đơn vị quảng cáo nhất định, đồng thời liên kết vùng quảng cáo đó với mã nhận dạng của một phần tử div trên trang sẽ chứa quảng cáo.
destroySlots	Huỷ các vùng đã cho, xoá tất cả các đối tượng và tham chiếu có liên quan của những vùng đó khỏi GPT.
disablePublisherConsole	Tắt Bảng điều khiển dành cho nhà xuất bản của Google.
display	Hướng dẫn các dịch vụ khe cắm kết xuất khe cắm.
enableServices	Cho phép tất cả các dịch vụ GPT đã được xác định cho các vùng quảng cáo trên trang.
getConfig	Lấy các lựa chọn cấu hình chung cho trang do setConfig đặt.
getVersion	Trả về phiên bản hiện tại của GPT.
openConsole	Mở Bảng điều khiển dành cho nhà xuất bản của Google.
pubads	Trả về một giá trị tham chiếu đến PubAdsService.
setAdIframeTitle	Đặt tiêu đề cho tất cả iframe vùng chứa quảng cáo do PubAdsService tạo, kể từ thời điểm này trở đi.
setConfig	Đặt các lựa chọn cấu hình chung cho trang.
sizeMapping	Tạo một SizeMappingBuilder mới.

Bí danh loại

---

GeneralSize

GeneralSize: SingleSize | MultiSize

Một cấu hình kích thước hợp lệ cho một vị trí, có thể là một hoặc nhiều kích thước.

---

MultiSize

MultiSize: SingleSize[]

Danh sách các kích thước hợp lệ riêng lẻ.

---

NamedSize

NamedSize: "fluid" | ["fluid"]

Các kích thước được đặt tên mà một vùng quảng cáo có thể có. Trong hầu hết các trường hợp, kích thước là một hình chữ nhật có kích thước cố định, nhưng có một số trường hợp chúng ta cần các loại quy cách kích thước khác. Chỉ những kích thước có tên sau đây là hợp lệ:

• fluid: vùng chứa quảng cáo có chiều rộng bằng 100% div gốc, sau đó thay đổi kích thước chiều cao để phù hợp với nội dung mẫu quảng cáo. Tương tự như cách các phần tử khối thông thường hoạt động trên một trang. Dùng cho quảng cáo gốc (xem bài viết liên quan). Xin lưu ý rằng cả fluid và ['fluid'] đều là các biểu mẫu được chấp nhận để khai báo kích thước vùng quảng cáo là linh hoạt.

---

SingleSize

SingleSize: SingleSizeArray | NamedSize

Một kích thước hợp lệ duy nhất cho một vị trí.

---

SingleSizeArray

SingleSizeArray: [number, number]

Mảng gồm 2 số biểu thị [chiều rộng, chiều cao].

---

SizeMapping

SizeMapping: [SingleSizeArray, GeneralSize]

Một mối liên kết giữa kích thước khung hiển thị và kích thước quảng cáo. Dùng cho quảng cáo thích ứng.

---

SizeMappingArray

SizeMappingArray: SizeMapping[]

Danh sách các mối liên kết kích thước.

Biến

---

Const apiReady

apiReady: boolean | undefined

Cờ cho biết API GPT đã được tải và sẵn sàng được gọi. Thuộc tính này sẽ chỉ là undefined cho đến khi API sẵn sàng.

Xin lưu ý rằng cách xử lý không đồng bộ được đề xuất là sử dụng googletag.cmd để xếp hàng các lệnh gọi lại khi GPT sẵn sàng. Các lệnh gọi lại này không cần kiểm tra googletag.apiReady vì chúng chắc chắn sẽ thực thi sau khi API được thiết lập.

---

Const cmd

cmd: ((this: typeof globalThis) => void)[] | CommandArray

Tham chiếu đến hàng đợi lệnh chung để thực thi không đồng bộ các lệnh gọi liên quan đến GPT.

Cú pháp thẻ GPT trên trang sẽ khởi tạo biến googletag.cmd thành một mảng JavaScript trống và cmd.push là phương thức Array.push tiêu chuẩn giúp thêm một phần tử vào cuối mảng. Khi JavaScript GPT được tải, JavaScript này sẽ xem xét mảng và thực thi tất cả các hàm theo thứ tự. Sau đó, tập lệnh sẽ thay thế cmd bằng một đối tượng CommandArray có phương thức đẩy được xác định để thực thi đối số hàm được truyền vào. Cơ chế này cho phép GPT giảm độ trễ cảm nhận bằng cách tìm nạp JavaScript không đồng bộ trong khi cho phép trình duyệt tiếp tục hiển thị trang.

Ví dụ:

JavaScript

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

JavaScript (cũ)

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

Cờ cho biết PubAdsService đã được bật, tải và hoạt động đầy đủ. Thuộc tính này sẽ chỉ là undefined cho đến khi enableServices được gọi và PubAdsService được tải và khởi chạy.

---

secureSignalProviders

secureSignalProviders: SecureSignalProvider[] | SecureSignalProvidersArray | undefined

Tham chiếu đến mảng nhà cung cấp tín hiệu an toàn.

Mảng nhà cung cấp tín hiệu an toàn chấp nhận một chuỗi các hàm tạo tín hiệu và gọi chúng theo thứ tự. Mục đích của hàm này là thay thế một mảng tiêu chuẩn dùng để xếp hàng các hàm tạo tín hiệu sẽ được gọi khi GPT được tải.

Ví dụ:

JavaScript

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

JavaScript (cũ)

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");
  },
});

Xem thêm

• Chia sẻ tín hiệu an toàn với bên đặt giá thầu

Hàm

---

companionAds

companionAds(): CompanionAdsService

Trả về một tham chiếu đến CompanionAdsService.

Giá trị trả về
CompanionAdsService	Dịch vụ Quảng cáo đồng hành.

---

defineOutOfPageSlot

defineOutOfPageSlot(adUnitPath: string, div?: string | OutOfPageFormat): Slot | null

Tạo một vùng quảng cáo nằm ngoài trang với đường dẫn đơn vị quảng cáo nhất định.

Đối với quảng cáo tuỳ chỉnh nằm ngoài trang, div là mã nhận dạng của phần tử div sẽ chứa quảng cáo. Hãy xem bài viết về mẫu quảng cáo nằm ngoài trang để biết thêm thông tin.

Đối với quảng cáo nằm ngoài trang do GPT quản lý, div là một OutOfPageFormat được hỗ trợ.

Ví dụ:

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);

JavaScript (cũ)

// 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);

Xem thêm

• Hiển thị quảng cáo có tặng thưởng
• Hiển thị quảng cáo xen kẽ trên web
• Hiển thị quảng cáo cố định
• Hiển thị quảng cáo ngoài trang

Thông số
adUnitPath: string	Đường dẫn đầy đủ của đơn vị quảng cáo có mã mạng và mã đơn vị quảng cáo.
Optional div: string | OutOfPageFormat	Mã nhận dạng của div sẽ chứa đơn vị quảng cáo này hoặc OutOfPageFormat.

Giá trị trả về
Slot | null	Vị trí mới tạo hoặc null nếu không tạo được vị trí.

---

defineSlot

defineSlot(adUnitPath: string, size: GeneralSize, div?: string): Slot | null

Tạo một vùng quảng cáo có đường dẫn và kích thước đơn vị quảng cáo nhất định, đồng thời liên kết vùng quảng cáo đó với mã nhận dạng của một phần tử div trên trang sẽ chứa quảng cáo.

Ví dụ:

JavaScript

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

JavaScript (cũ)

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

TypeScript

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

Xem thêm

• Bắt đầu sử dụng Thẻ nhà xuất bản của Google

Thông số
adUnitPath: string	Đường dẫn đầy đủ của đơn vị quảng cáo có mã mạng và mã đơn vị.
size: GeneralSize	Chiều rộng và chiều cao của khe được thêm. Đây là kích thước được dùng trong yêu cầu quảng cáo nếu không có ánh xạ kích thước thích ứng hoặc kích thước của khung hiển thị nhỏ hơn kích thước nhỏ nhất được cung cấp trong ánh xạ.
Optional div: string	Mã nhận dạng của thẻ div sẽ chứa đơn vị quảng cáo này.

Giá trị trả về
Slot | null	Vị trí mới tạo hoặc null nếu không tạo được vị trí.

---

destroySlots

destroySlots(slots?: Slot[]): boolean

Huỷ các vùng đã cho, xoá tất cả các đối tượng và tham chiếu có liên quan của những vùng đó khỏi GPT. API này không hỗ trợ các vị trí passback và vị trí đồng hành.

Khi gọi API này trên một vị trí, quảng cáo sẽ bị xoá và đối tượng vị trí sẽ bị xoá khỏi trạng thái nội bộ do GPT duy trì. Việc gọi thêm bất kỳ hàm nào trên đối tượng khe sẽ dẫn đến hành vi không xác định. Lưu ý rằng trình duyệt vẫn có thể không giải phóng bộ nhớ được liên kết với vị trí đó nếu trang của nhà xuất bản duy trì một thông tin tham chiếu đến vị trí đó. Khi gọi API này, div được liên kết với vùng đó sẽ có thể được dùng lại.

Cụ thể, việc huỷ một vùng sẽ xoá quảng cáo khỏi lượt xem trang duy trì lâu dài của GPT, do đó, các yêu cầu trong tương lai sẽ không bị ảnh hưởng bởi các quảng cáo chặn hoặc loại trừ cạnh tranh liên quan đến quảng cáo này. Nếu không gọi hàm này trước khi xoá thẻ div của một vị trí khỏi trang, bạn sẽ gặp phải hành vi không xác định.

Ví dụ:

JavaScript

// 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 (cũ)

// 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();

Thông số
Optional slots: Slot[]	Mảng các ô cần phá huỷ. Mảng là không bắt buộc; tất cả các khe sẽ bị huỷ nếu bạn không chỉ định.

Giá trị trả về
boolean	true nếu các khe đã bị huỷ, false nếu không.

---

disablePublisherConsole

disablePublisherConsole(): void

Tắt Bảng điều khiển dành cho nhà xuất bản của Google.

Xem thêm

• Bảng điều khiển dành cho nhà xuất bản của Google

---

hiển thị

display(divOrSlot: string | Element | Slot): void

Hướng dẫn các dịch vụ khe cắm kết xuất khe cắm. Mỗi vùng quảng cáo chỉ được hiển thị một lần trên mỗi trang. Bạn phải xác định tất cả các vị trí và liên kết một dịch vụ với các vị trí đó trước khi hiển thị. Lệnh gọi hiển thị không được diễn ra cho đến khi phần tử xuất hiện trong DOM. Cách thông thường để đạt được điều đó là đặt nó trong một khối tập lệnh trong phần tử div có tên trong lệnh gọi phương thức.

Nếu bạn đang sử dụng cấu trúc yêu cầu duy nhất (SRA), thì tất cả các vùng quảng cáo chưa được tìm nạp tại thời điểm gọi phương thức này sẽ được tìm nạp cùng một lúc. Để buộc một vùng quảng cáo không hiển thị, bạn phải xoá toàn bộ div.

Xem thêm

• Bắt đầu sử dụng Thẻ nhà xuất bản của Google
• Hiển thị quảng cáo thử nghiệm
• Kiểm soát việc tải và làm mới quảng cáo

Thông số
divOrSlot: string | Element | Slot	Mã nhận dạng của phần tử div chứa vị trí quảng cáo hoặc phần tử div, hoặc đối tượng vị trí. Nếu bạn cung cấp một phần tử div, thì phần tử đó phải có một thuộc tính "id" khớp với mã nhận dạng được truyền vào defineSlot.

---

enableServices

enableServices(): void

Cho phép tất cả các dịch vụ GPT đã được xác định cho các vùng quảng cáo trên trang.

---

getConfig

getConfig(keys: string | string[]): Pick<PageSettingsConfig, "adsenseAttributes" | "disableInitialLoad" | "targeting">

Nhận các lựa chọn cấu hình chung cho trang do setConfig đặt.

Phương thức này không hỗ trợ tất cả các thuộc tính setConfig(). Sau đây là các thuộc tính được hỗ trợ:

• adsenseAttributes
• disableInitialLoad
• targeting

Ví dụ:

JavaScript

// 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 (cũ)

// 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"]);

Thông số
keys: string | string[]	Khoá của các lựa chọn cấu hình cần nhận.

Giá trị trả về
Pick<PageSettingsConfig, "adsenseAttributes" | "disableInitialLoad" | "targeting">	Các lựa chọn cấu hình cho khe.

---

getVersion

getVersion(): string

Trả về phiên bản hiện tại của GPT.

Xem thêm

• Nhật ký phiên bản GPT

Giá trị trả về
string	Chuỗi phiên bản GPT hiện đang thực thi.

---

openConsole

openConsole(div?: string): void

Mở Bảng điều khiển dành cho nhà xuất bản của Google.

Ví dụ:

JavaScript

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

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

JavaScript (cũ)

// 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();

Xem thêm

• Bảng điều khiển dành cho nhà xuất bản của Google

Thông số
Optional div: string	Mã nhận dạng div của vùng quảng cáo. Giá trị này là không bắt buộc. Khi được cung cấp, Bảng điều khiển dành cho nhà xuất bản sẽ cố gắng mở với thông tin chi tiết về vị trí quảng cáo được chỉ định ở chế độ xem.

---

pubads

pubads(): PubAdsService

Trả về một giá trị tham chiếu đến PubAdsService.

Giá trị trả về
PubAdsService	Dịch vụ Quảng cáo của nhà xuất bản.

---

setAdIframeTitle

setAdIframeTitle(title: string): void

Đặt tiêu đề cho tất cả iframe vùng chứa quảng cáo do PubAdsService tạo, kể từ thời điểm này trở đi.

Ví dụ:

JavaScript

googletag.setAdIframeTitle("title");

JavaScript (cũ)

googletag.setAdIframeTitle("title");

TypeScript

googletag.setAdIframeTitle("title");

Thông số
title: string	Tiêu đề mới cho tất cả iframe vùng chứa quảng cáo.

---

setConfig

setConfig(config: PageSettingsConfig): void

Đặt các lựa chọn cấu hình chung cho trang.

Thông số
config: PageSettingsConfig

---

sizeMapping

sizeMapping(): SizeMappingBuilder

Tạo một SizeMappingBuilder mới.

Xem thêm

• Kích thước quảng cáo: Quảng cáo thích ứng

Giá trị trả về
SizeMappingBuilder	Một trình tạo mới.

---

googletag.CommandArray

Mảng lệnh chấp nhận một chuỗi các hàm và gọi chúng theo thứ tự. Mục đích của hàm này là thay thế một mảng tiêu chuẩn dùng để xếp hàng các hàm sẽ được gọi sau khi GPT được tải.

Phương thức
push	Thực thi trình tự các hàm được chỉ định trong các đối số theo thứ tự.

Phương thức

---

push

push(...f: ((this: typeof globalThis) => void)[]): number

Thực thi trình tự các hàm được chỉ định trong các đối số theo thứ tự.

Ví dụ:

JavaScript

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

JavaScript (cũ)

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());
});

Thông số
Rest ...f: ((this: typeof globalThis) => void)[]	Một hàm JavaScript sẽ được thực thi. Liên kết thời gian chạy sẽ luôn là globalThis. Hãy cân nhắc việc truyền một hàm mũi tên để giữ lại giá trị this của ngữ cảnh từ vựng bao quanh.

Giá trị trả về
number	Số lượng lệnh đã xử lý cho đến thời điểm hiện tại. Điều này tương thích với giá trị trả về của Array.push (độ dài hiện tại của mảng).

---

googletag.CompanionAdsService

Mở rộng Service

Dịch vụ Quảng cáo đồng hành. Dịch vụ này được quảng cáo dạng video sử dụng để hiển thị quảng cáo đồng hành.

Phương thức
addEventListener	Đăng ký một trình nghe cho phép bạn thiết lập và gọi một hàm JavaScript khi một sự kiện GPT cụ thể xảy ra trên trang. Kế thừa từ Service.addEventListener
getSlots	Lấy danh sách các khung giờ được liên kết với dịch vụ này. Kế thừa từ Service.getSlots
removeEventListener	Xoá một trình nghe đã đăng ký trước đó. Kế thừa từ Service.removeEventListener
setRefreshUnfilledSlots	Đặt xem các vùng quảng cáo đồng hành chưa được lấp đầy có được tự động chèn lấp hay không.

Xem thêm

• Quảng cáo đồng hành cho video và âm thanh

Phương thức

---

setRefreshUnfilledSlots

setRefreshUnfilledSlots(value: boolean): void

Đặt xem các vùng quảng cáo đồng hành chưa được lấp đầy có được tự động chèn lấp hay không.

Phương thức này có thể được gọi nhiều lần trong vòng đời của trang để bật và tắt tính năng chèn lấp. Chỉ những vùng quảng cáo cũng được đăng ký bằng PubAdsService mới được chèn lấp. Do các quy định hạn chế về chính sách, phương thức này không được thiết kế để điền vào các vị trí đồng hành trống khi một video trên Ad Exchange được phân phát.

Ví dụ:

JavaScript

googletag.companionAds().setRefreshUnfilledSlots(true);

JavaScript (cũ)

googletag.companionAds().setRefreshUnfilledSlots(true);

TypeScript

googletag.companionAds().setRefreshUnfilledSlots(true);

Thông số
value: boolean	true để tự động điền lại các vị trí chưa được điền, false để giữ nguyên các vị trí đó.

---

googletag.PrivacySettingsConfig

Đối tượng cấu hình cho chế độ cài đặt quyền riêng tư.

Thuộc tính
childDirectedTreatment?	Cho biết liệu trang có nên được xử lý như trang dành cho trẻ em hay không.
limitedAds?	Cho phép phân phát ở chế độ quảng cáo bị hạn chế để hỗ trợ nhu cầu tuân thủ quy định của nhà xuất bản.
nonPersonalizedAds?	Cho phép phân phát ở chế độ quảng cáo không được cá nhân hoá để hỗ trợ nhu cầu tuân thủ quy định của nhà xuất bản.
restrictDataProcessing?	Cho phép phân phát chạy ở chế độ xử lý bị hạn chế để hỗ trợ nhu cầu tuân thủ quy định của nhà xuất bản.
trafficSource?	Cho biết liệu các yêu cầu có đại diện cho lưu lượng truy cập đã mua hay lưu lượng truy cập tự nhiên hay không.
underAgeOfConsent?	Cho biết có đánh dấu yêu cầu quảng cáo là của người dùng chưa đủ độ tuổi hợp pháp để tự quản lý tài khoản hay không.

Xem thêm

• Định cấu hình chế độ cài đặt quyền riêng tư

Thuộc tính

---

Optional childDirectedTreatment

childDirectedTreatment?: boolean

Cho biết liệu trang có nên được xử lý như trang dành cho trẻ em hay không. Đặt thành null để xoá cấu hình.

---

Optional limitedAds

limitedAds?: boolean

Cho phép phân phát ở chế độ quảng cáo bị hạn chế để hỗ trợ các nhu cầu tuân thủ quy định của nhà xuất bản.

Bạn có thể hướng dẫn GPT yêu cầu quảng cáo bị hạn chế theo hai cách:

• Tự động, bằng cách sử dụng tín hiệu từ một nền tảng quản lý sự đồng ý theo TCF phiên bản 2.0 của IAB.
• Theo cách thủ công, bằng cách đặt giá trị của trường này thành true.

Bạn chỉ có thể định cấu hình quảng cáo bị hạn chế theo cách thủ công khi GPT được tải từ URL của quảng cáo bị hạn chế. Việc cố gắng sửa đổi chế độ cài đặt này khi GPT đã được tải từ URL chuẩn sẽ tạo ra một cảnh báo trên Bảng điều khiển dành cho nhà xuất bản.

Xin lưu ý rằng bạn không cần phải bật quảng cáo bị hạn chế theo cách thủ công khi đang sử dụng CMP.

Ví dụ:

JavaScript

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

JavaScript (cũ)

// 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,
});

Xem thêm

• Hiển thị quảng cáo bị hạn chế

---

Optional nonPersonalizedAds

nonPersonalizedAds?: boolean

Cho phép phân phát ở chế độ quảng cáo không được cá nhân hoá để hỗ trợ nhu cầu tuân thủ quy định của nhà xuất bản.

---

Optional restrictDataProcessing

restrictDataProcessing?: boolean

Cho phép phân phát chạy ở chế độ xử lý bị hạn chế để hỗ trợ nhu cầu tuân thủ quy định của nhà xuất bản.

---

Optional trafficSource

trafficSource?: TrafficSource

Cho biết liệu các yêu cầu có đại diện cho lưu lượng truy cập đã mua hay lưu lượng truy cập tự nhiên hay không. Giá trị này sẽ điền sẵn phương diện Nguồn lưu lượng truy cập trong báo cáo Ad Manager. Nếu bạn không đặt, nguồn lưu lượng truy cập sẽ mặc định là undefined trong báo cáo.

Ví dụ:

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,
});

JavaScript (cũ)

// 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

Cho biết có đánh dấu yêu cầu quảng cáo là của người dùng chưa đủ độ tuổi hợp pháp để tự quản lý tài khoản hay không. Đặt thành null để xoá cấu hình.

---

googletag.PubAdsService

Mở rộng Service

Dịch vụ Quảng cáo của nhà xuất bản. Dịch vụ này được dùng để tìm nạp và hiển thị quảng cáo từ tài khoản Google Ad Manager của bạn.

Phương thức
addEventListener	Đăng ký một trình nghe cho phép bạn thiết lập và gọi một hàm JavaScript khi một sự kiện GPT cụ thể xảy ra trên trang. Kế thừa từ Service.addEventListener
clear	Xoá quảng cáo khỏi các vị trí đã cho và thay thế bằng nội dung trống.
clearCategoryExclusions	Không dùng nữa. Xoá tất cả nhãn loại trừ danh mục quảng cáo ở cấp trang.
clearTargeting	Không dùng nữa. Xoá các thông số nhắm mục tiêu tuỳ chỉnh cho một khoá cụ thể hoặc cho tất cả các khoá.
collapseEmptyDivs	Không dùng nữa. Cho phép thu gọn các phần tử div của vùng quảng cáo để các phần tử này không chiếm bất kỳ khoảng trống nào trên trang khi không có nội dung quảng cáo nào để hiển thị.
disableInitialLoad	Không dùng nữa. Tắt các yêu cầu quảng cáo khi tải trang, nhưng cho phép yêu cầu quảng cáo bằng lệnh gọi PubAdsService.refresh.
display	Tạo và hiển thị một vùng quảng cáo có đường dẫn và kích thước đơn vị quảng cáo nhất định.
enableLazyLoad	Không dùng nữa. Cho phép tải từng phần trong GPT theo định nghĩa của đối tượng cấu hình.
enableSingleRequest	Không dùng nữa. Cho phép chế độ yêu cầu đơn để tìm nạp nhiều quảng cáo cùng một lúc.
enableVideoAds	Không dùng nữa. Báo hiệu cho GPT rằng quảng cáo dạng video sẽ xuất hiện trên trang.
get	Không dùng nữa. Trả về giá trị cho thuộc tính AdSense được liên kết với khoá đã cho.
getAttributeKeys	Không dùng nữa. Trả về các khoá thuộc tính đã được đặt trên dịch vụ này.
getSlots	Lấy danh sách các khung giờ được liên kết với dịch vụ này. Kế thừa từ Service.getSlots
getTargeting	Không dùng nữa. Trả về một thông số nhắm mục tiêu cụ thể ở cấp dịch vụ tuỳ chỉnh mà bạn đã đặt.
getTargetingKeys	Không dùng nữa. Trả về danh sách tất cả các khoá nhắm mục tiêu tuỳ chỉnh ở cấp dịch vụ đã được đặt.
isInitialLoadDisabled	Không dùng nữa. Trả về việc lệnh gọi PubAdsService.disableInitialLoad trước đó có vô hiệu hoá thành công các yêu cầu ban đầu về quảng cáo hay không.
refresh	Tìm nạp và hiển thị quảng cáo mới cho một số hoặc tất cả các vùng trên trang.
removeEventListener	Xoá một trình nghe đã đăng ký trước đó. Kế thừa từ Service.removeEventListener
set	Không dùng nữa. Đặt các giá trị cho những thuộc tính AdSense áp dụng cho tất cả các vùng quảng cáo trong dịch vụ Quảng cáo của nhà xuất bản.
setCategoryExclusion	Không dùng nữa. Đặt tiêu chí loại trừ danh mục quảng cáo ở cấp trang cho tên nhãn đã cho.
setCentering	Không dùng nữa. Bật và tắt chế độ căn giữa quảng cáo theo chiều ngang.
setForceSafeFrame	Không dùng nữa. Định cấu hình xem có nên buộc tất cả quảng cáo trên trang hiển thị bằng cách dùng vùng chứa SafeFrame hay không.
setLocation	Không dùng nữa. Truyền thông tin vị trí từ các trang web để bạn có thể nhắm mục tiêu theo vị trí địa lý cho các mục hàng đến những vị trí cụ thể.
setPrivacySettings	Cho phép định cấu hình tất cả các chế độ cài đặt quyền riêng tư từ một API duy nhất bằng cách sử dụng một đối tượng cấu hình.
setPublisherProvidedId	Đặt giá trị cho mã nhận dạng do nhà xuất bản cung cấp.
setSafeFrameConfig	Không dùng nữa. Đặt các lựa chọn ưu tiên ở cấp trang cho cấu hình SafeFrame.
setTargeting	Không dùng nữa. Đặt các thông số nhắm mục tiêu tuỳ chỉnh cho một khoá nhất định áp dụng cho tất cả các vùng quảng cáo của dịch vụ Quảng cáo của nhà xuất bản.
setVideoContent	Không dùng nữa. Đặt thông tin nội dung video sẽ được gửi cùng với các yêu cầu quảng cáo cho mục đích nhắm mục tiêu và loại trừ nội dung.
updateCorrelator	Thay đổi giá trị tương quan được gửi cùng với các yêu cầu quảng cáo, từ đó bắt đầu một lượt xem trang mới.

Phương thức

---

xoá

clear(slots?: Slot[]): boolean

Xoá quảng cáo khỏi các vị trí đã cho và thay thế bằng nội dung trống. Các vị trí quảng cáo sẽ được đánh dấu là chưa tìm nạp.

Cụ thể, việc xoá một vị trí quảng cáo sẽ loại bỏ quảng cáo khỏi lượt xem trang kéo dài của GPT, do đó, các yêu cầu trong tương lai sẽ không bị ảnh hưởng bởi các quảng cáo chặn hoặc loại trừ cạnh tranh liên quan đến quảng cáo này.

Ví dụ:

JavaScript

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 (cũ)

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();

Thông số
Optional slots: Slot[]	Mảng các ô cần xoá. Mảng là không bắt buộc; tất cả các khe sẽ bị xoá nếu bạn không chỉ định.

Giá trị trả về
boolean	Trả về true nếu các vùng đã được xoá, nếu không thì trả về false.

---

clearCategoryExclusions

clearCategoryExclusions(): PubAdsService

Xoá tất cả nhãn loại trừ danh mục quảng cáo ở cấp trang. Điều này sẽ hữu ích nếu bạn muốn làm mới vị trí.

Không dùng nữa: Hãy sử dụng PageSettingsConfig.categoryExclusion.

Ví dụ:

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.

JavaScript (cũ)

// 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.

Xem thêm

• Nhãn tuỳ chỉnh để chặn quảng cáo

Giá trị trả về
PubAdsService	Đối tượng dịch vụ mà phương thức được gọi.

---

clearTargeting

clearTargeting(key?: string): PubAdsService

Xoá các thông số nhắm mục tiêu tuỳ chỉnh cho một khoá cụ thể hoặc cho tất cả các khoá.

Không dùng nữa: Thay vào đó, hãy sử dụng PageSettingsConfig.targeting.

Ví dụ:

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.

JavaScript (cũ)

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.

Xem thêm

• Nhắm mục tiêu khoá-giá trị

Thông số
Optional key: string	Khoá thông số nhắm mục tiêu. Khoá này không bắt buộc; tất cả các thông số nhắm mục tiêu sẽ bị xoá nếu bạn không chỉ định.

Giá trị trả về
PubAdsService	Đối tượng dịch vụ mà phương thức được gọi.

---

collapseEmptyDivs

collapseEmptyDivs(collapseBeforeAdFetch?: boolean): boolean

Cho phép thu gọn các phần tử div của vùng quảng cáo để các phần tử này không chiếm bất kỳ khoảng trống nào trên trang khi không có nội dung quảng cáo nào để hiển thị. Bạn phải đặt chế độ này trước khi bật dịch vụ.

Không dùng nữa: Thay vào đó, hãy sử dụng PageSettingsConfig.collapseDiv.

Xem thêm

• Thu gọn vùng quảng cáo trống
• Giảm thiểu mức thay đổi bố cục

Thông số
Optional collapseBeforeAdFetch: boolean	Có thu gọn các vị trí ngay cả trước khi quảng cáo được tìm nạp hay không. Tham số này không bắt buộc; nếu bạn không cung cấp, false sẽ được dùng làm giá trị mặc định.

Giá trị trả về
boolean	Trả về true nếu chế độ thu gọn div đã được bật và false nếu không thể bật chế độ thu gọn vì phương thức này được gọi sau khi dịch vụ được bật.

---

disableInitialLoad

disableInitialLoad(): void

Tắt các yêu cầu về quảng cáo khi tải trang, nhưng cho phép yêu cầu quảng cáo bằng lệnh gọi PubAdsService.refresh. Bạn nên thiết lập chế độ này trước khi bật dịch vụ. Bạn phải sử dụng chế độ không đồng bộ; nếu không, bạn sẽ không thể yêu cầu quảng cáo bằng cách sử dụng refresh.

Không dùng nữa: Thay vào đó, hãy sử dụng PageSettingsConfig.disableInitialLoad.

Xem thêm

• Kiểm soát việc tải và làm mới quảng cáo
• Kiểm soát việc tạo lô SRA

---

hiển thị

display(adUnitPath: string, size: GeneralSize, div?: string | Element, clickUrl?: string): void

Tạo và hiển thị một vùng quảng cáo có đường dẫn và kích thước đơn vị quảng cáo nhất định. Phương thức này không hoạt động ở chế độ yêu cầu duy nhất.

Lưu ý: Khi phương thức này được gọi, một ảnh chụp nhanh về trạng thái của vị trí và trang sẽ được tạo để đảm bảo tính nhất quán khi gửi yêu cầu quảng cáo và hiển thị phản hồi. Mọi thay đổi được thực hiện đối với trạng thái của vị trí hoặc trang sau khi phương thức này được gọi (bao gồm cả tiêu chí nhắm mục tiêu, chế độ cài đặt quyền riêng tư, SafeFrame bắt buộc, v.v.) sẽ chỉ áp dụng cho các yêu cầu display() hoặc refresh() tiếp theo.

Ví dụ:

JavaScript

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

JavaScript (cũ)

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

TypeScript

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

Xem thêm

• Hiển thị quảng cáo thử nghiệm
• Kiểm soát việc tải và làm mới quảng cáo

Thông số
adUnitPath: string	Đường dẫn của đơn vị quảng cáo của vùng quảng cáo sẽ được hiển thị.
size: GeneralSize	Chiều rộng và chiều cao của khe cắm.
Optional div: string | Element	Mã nhận dạng của div chứa vị trí hoặc chính phần tử div.
Optional clickUrl: string	URL lượt nhấp để sử dụng trên vị trí này.

---

enableLazyLoad

enableLazyLoad(config?: {
  fetchMarginPercent?: number;
  mobileScaling?: number;
  renderMarginPercent?: number;
}): void

Cho phép tải từng phần trong GPT theo định nghĩa của đối tượng cấu hình. Để xem các ví dụ chi tiết hơn, hãy xem mẫu Tải từng phần.

Lưu ý: Tính năng tìm nạp từng phần trong SRA chỉ hoạt động nếu tất cả các vị trí đều nằm ngoài lề tìm nạp.

Không dùng nữa: Thay vào đó, hãy sử dụng PageSettingsConfig.lazyLoad.

Ví dụ:

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,
});

JavaScript (cũ)

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,
});

Xem thêm

• Các phương pháp hay nhất về quảng cáo: Ưu tiên các vị trí quảng cáo "quan trọng"
• Tải từng phần

Thông số

Optional config: {   fetchMarginPercent?: number;   mobileScaling?: number;   renderMarginPercent?: number; }

Đối tượng cấu hình cho phép tuỳ chỉnh hành vi trì hoãn. Mọi cấu hình bị bỏ qua sẽ sử dụng một chế độ mặc định do Google đặt và sẽ được điều chỉnh theo thời gian. Để tắt một chế độ cài đặt cụ thể, chẳng hạn như lề tìm nạp, hãy đặt giá trị thành -1. fetchMarginPercent Khoảng cách tối thiểu từ khung hiển thị hiện tại mà một vùng phải có trước khi chúng tôi tìm nạp quảng cáo dưới dạng tỷ lệ phần trăm kích thước khung hiển thị. Giá trị 0 có nghĩa là "khi vùng quảng cáo đi vào khung nhìn", 100 có nghĩa là "khi quảng cáo cách khung nhìn 1 khung", v.v. renderMarginPercent Khoảng cách tối thiểu từ khung hiển thị hiện tại mà một vị trí phải có trước khi chúng tôi hiển thị quảng cáo. Điều này cho phép tìm nạp trước quảng cáo, nhưng chờ kết xuất và tải các tài nguyên phụ khác xuống. Giá trị này hoạt động giống như fetchMarginPercent dưới dạng tỷ lệ phần trăm của khung hiển thị. mobileScaling Hệ số nhân được áp dụng cho lề trên thiết bị di động. Điều này cho phép các lề khác nhau trên thiết bị di động so với máy tính. Ví dụ: giá trị 2.0 sẽ nhân tất cả các lề với 2 trên thiết bị di động, làm tăng khoảng cách tối thiểu mà một ô có thể có trước khi tìm nạp và hiển thị.

---

enableSingleRequest

enableSingleRequest(): boolean

Cho phép chế độ yêu cầu đơn để tìm nạp nhiều quảng cáo cùng một lúc. Điều này yêu cầu bạn xác định và thêm tất cả các vùng quảng cáo của nhà xuất bản vào PubAdsService trước khi bật dịch vụ. Bạn phải đặt chế độ yêu cầu duy nhất trước khi bật dịch vụ.

Không dùng nữa: Thay vào đó, hãy sử dụng PageSettingsConfig.singleRequest.

Xem thêm

• Các phương pháp hay nhất về quảng cáo: Sử dụng Cấu trúc yêu cầu duy nhất một cách chính xác
• Kiểm soát việc tạo lô SRA

Giá trị trả về
boolean	Trả về true nếu chế độ yêu cầu duy nhất được bật và false nếu không thể bật chế độ yêu cầu duy nhất vì phương thức này được gọi sau khi dịch vụ được bật.

---

enableVideoAds

enableVideoAds(): void

Gửi tín hiệu đến GPT rằng quảng cáo dạng video sẽ xuất hiện trên trang. Điều này cho phép các quy tắc ràng buộc loại trừ cạnh tranh đối với quảng cáo hiển thị và quảng cáo dạng video. Nếu bạn biết nội dung video, hãy gọi PubAdsService.setVideoContent để có thể sử dụng tính năng loại trừ nội dung cho quảng cáo hiển thị.

Không dùng nữa: Thay vào đó, hãy sử dụng PageSettingsConfig.videoAds.

---

get

get(key: string): string

Trả về giá trị cho thuộc tính AdSense được liên kết với khoá đã cho.

Không dùng nữa: Thay vào đó, hãy dùng googletag.getConfig.

Ví dụ:

JavaScript

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

JavaScript (cũ)

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'.

Xem thêm

• Thuộc tính AdSense

Thông số
key: string	Tên của thuộc tính cần tìm.

Giá trị trả về
string	Giá trị hiện tại cho khoá thuộc tính hoặc null nếu khoá không có.

---

getAttributeKeys

getAttributeKeys(): string[]

Trả về các khoá thuộc tính đã được đặt trên dịch vụ này.

Không dùng nữa: Thay vào đó, hãy sử dụng googletag.getConfig.

Ví dụ:

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'].

JavaScript (cũ)

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'].

Giá trị trả về
string[]	Mảng khoá thuộc tính được đặt trên dịch vụ này. Thứ tự không xác định.

---

getTargeting

getTargeting(key: string): string[]

Trả về một tham số nhắm mục tiêu tuỳ chỉnh cụ thể ở cấp dịch vụ đã được đặt.

Không dùng nữa: Hãy sử dụng googletag.getConfig.

Ví dụ:

JavaScript

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

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

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

JavaScript (cũ)

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).

Thông số
key: string	Khoá nhắm mục tiêu cần tìm.

Giá trị trả về
string[]	Các giá trị được liên kết với khoá này hoặc một mảng trống nếu không có khoá như vậy.

---

getTargetingKeys

getTargetingKeys(): string[]

Trả về danh sách tất cả các khoá nhắm mục tiêu tuỳ chỉnh ở cấp dịch vụ đã được đặt.

Không dùng nữa: Thay vào đó, hãy dùng googletag.getConfig.

Ví dụ:

JavaScript

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

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

JavaScript (cũ)

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'].

Giá trị trả về
string[]	Mảng khoá nhắm mục tiêu. Thứ tự không xác định.

---

isInitialLoadDisabled

isInitialLoadDisabled(): boolean

Trả về việc yêu cầu ban đầu về quảng cáo có bị vô hiệu hoá thành công hay không bằng lệnh gọi PubAdsService.disableInitialLoad trước đó.

Không dùng nữa: Hãy sử dụng googletag.getConfig.

Giá trị trả về
boolean	Trả về true nếu lệnh gọi trước đó đến PubAdsService.disableInitialLoad thành công, nếu không thì trả về false.

---

refresh

refresh(slots?: Slot[], options?: {
  changeCorrelator: boolean;
}): void

Tìm nạp và hiển thị quảng cáo mới cho một số hoặc tất cả các vùng trên trang. Chỉ hoạt động ở chế độ kết xuất không đồng bộ.

Để hoạt động đúng cách trên tất cả các trình duyệt, bạn phải gọi refresh trước khi gọi display vùng quảng cáo. Nếu bạn bỏ qua lệnh gọi đến display, quá trình làm mới có thể hoạt động không như mong đợi. Nếu muốn, bạn có thể sử dụng phương thức PubAdsService.disableInitialLoad để ngăn display tìm nạp quảng cáo.

Việc làm mới một vùng quảng cáo sẽ xoá quảng cáo cũ khỏi lượt xem trang kéo dài của GPT, do đó, các yêu cầu trong tương lai sẽ không bị ảnh hưởng bởi tính năng khoanh vùng quảng cáo hoặc loại trừ cạnh tranh liên quan đến quảng cáo đó.

Ví dụ:

JavaScript

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 (cũ)

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 });

Xem thêm

• Kiểm soát việc tải và làm mới quảng cáo
• Làm mới vùng quảng cáo

Thông số
Optional slots: Slot[]	Các vị trí cần làm mới. Mảng là không bắt buộc; tất cả các khe sẽ được làm mới nếu bạn không chỉ định.
Optional options: {   changeCorrelator: boolean; }	Các lựa chọn cấu hình liên kết với lệnh gọi làm mới này. changeCorrelator Chỉ định có tạo bộ tương quan mới để tìm nạp quảng cáo hay không. Máy chủ quảng cáo của chúng tôi duy trì giá trị tương quan này trong thời gian ngắn (hiện tại là 30 giây, nhưng có thể thay đổi), sao cho các yêu cầu có cùng giá trị tương quan nhận được gần nhau sẽ được coi là một lượt xem trang duy nhất. Theo mặc định, một mã nhận dạng tương quan mới sẽ được tạo cho mỗi lần làm mới. Lưu ý: lựa chọn này không ảnh hưởng đến lượt xem trang duy trì lâu dài của GPT. Lựa chọn này tự động phản ánh những quảng cáo hiện có trên trang và không có thời gian hết hạn.

---

set

set(key: string, value: string): PubAdsService

Đặt các giá trị cho những thuộc tính AdSense áp dụng cho tất cả các vùng quảng cáo trong dịch vụ Quảng cáo của nhà xuất bản.

Nếu bạn gọi hàm này nhiều lần cho cùng một khoá, các giá trị đã đặt trước đó cho khoá đó sẽ bị ghi đè. Bạn phải đặt tất cả các giá trị trước khi gọi display hoặc refresh.

Không dùng nữa: Thay vào đó, hãy dùng PageSettingsConfig.adsenseAttributes.

Ví dụ:

JavaScript

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

JavaScript (cũ)

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

TypeScript

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

Xem thêm

• Thuộc tính AdSense

Thông số
key: string	Tên của thuộc tính.
value: string	Giá trị thuộc tính.

Giá trị trả về
PubAdsService	Đối tượng dịch vụ mà phương thức được gọi.

---

setCategoryExclusion

setCategoryExclusion(categoryExclusion: string): PubAdsService

Đặt tiêu chí loại trừ danh mục quảng cáo cấp trang cho tên nhãn đã cho.

Không dùng nữa: Thay vào đó, hãy sử dụng PageSettingsConfig.categoryExclusion.

Ví dụ:

JavaScript

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

JavaScript (cũ)

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

TypeScript

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

Xem thêm

• Nhãn tuỳ chỉnh để chặn quảng cáo

Thông số
categoryExclusion: string	Nhãn loại trừ danh mục quảng cáo cần thêm.

Giá trị trả về
PubAdsService	Đối tượng dịch vụ mà phương thức được gọi.

---

setCentering

setCentering(centerAds: boolean): void

Bật và tắt tính năng căn giữa quảng cáo theo chiều ngang. Theo mặc định, tính năng căn giữa bị tắt. Trong gpt_mobile.js cũ, tính năng căn giữa được bật theo mặc định.

Phương thức này phải được gọi trước khi gọi display hoặc refresh vì chỉ những quảng cáo được yêu cầu sau khi gọi phương thức này mới được căn giữa.

Không dùng nữa: Thay vào đó, hãy sử dụng PageSettingsConfig.centering.

Ví dụ:

JavaScript

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

JavaScript (cũ)

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

TypeScript

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

Thông số
centerAds: boolean	true để căn giữa quảng cáo, false để căn trái quảng cáo.

---

setForceSafeFrame

setForceSafeFrame(forceSafeFrame: boolean): PubAdsService

Định cấu hình xem tất cả quảng cáo trên trang có bắt buộc phải hiển thị bằng vùng chứa SafeFrame hay không.

Xin lưu ý những điều sau đây khi sử dụng API này:

• Chế độ cài đặt này sẽ chỉ có hiệu lực đối với các yêu cầu quảng cáo tiếp theo được thực hiện cho các vị trí tương ứng.
• Nếu được chỉ định, chế độ cài đặt cấp vùng quảng cáo sẽ luôn ghi đè chế độ cài đặt cấp trang.
• Nếu được đặt thành true (ở cấp độ vùng quảng cáo hoặc cấp độ trang), quảng cáo sẽ luôn được hiển thị bằng vùng chứa SafeFrame, bất kể lựa chọn nào được đưa ra trong giao diện người dùng Google Ad Manager.
• Tuy nhiên, nếu được đặt thành false hoặc không được chỉ định, quảng cáo sẽ được hiển thị bằng vùng chứa SafeFrame tuỳ thuộc vào loại mẫu quảng cáo và lựa chọn được thực hiện trong giao diện người dùng Google Ad Manager.
• Bạn nên sử dụng API này một cách thận trọng vì API này có thể ảnh hưởng đến hành vi của những mẫu quảng cáo cố gắng thoát khỏi iFrame hoặc dựa vào việc các mẫu quảng cáo đó được hiển thị trực tiếp trong trang của nhà xuất bản.

Không dùng nữa: Hãy sử dụng PageSettingsConfig.safeFrame.

Ví dụ:

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");

JavaScript (cũ)

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");

Xem thêm

• Hiển thị mẫu quảng cáo bằng SafeFrame

Thông số
forceSafeFrame: boolean	true để buộc tất cả quảng cáo trên trang được hiển thị trong SafeFrame và false để thay đổi chế độ cài đặt trước đó thành false. Nếu bạn đặt chế độ này thành false khi chưa chỉ định trước đó, thì sẽ không có gì thay đổi.

Giá trị trả về
PubAdsService	Đối tượng dịch vụ mà phương thức được gọi.

---

setLocation

setLocation(address: string): PubAdsService

Truyền thông tin vị trí từ các trang web để bạn có thể nhắm mục tiêu theo vị trí địa lý cho các mục hàng đến những vị trí cụ thể.

Không dùng nữa: Thay vào đó, hãy sử dụng PageSettingsConfig.location.

Ví dụ:

JavaScript

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

JavaScript (cũ)

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

TypeScript

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

Thông số
address: string	Địa chỉ dạng tự do.

Giá trị trả về
PubAdsService	Đối tượng dịch vụ mà phương thức được gọi.

---

setPrivacySettings

setPrivacySettings(privacySettings: PrivacySettingsConfig): PubAdsService

Cho phép định cấu hình tất cả chế độ cài đặt quyền riêng tư từ một API duy nhất bằng cách sử dụng một đối tượng cấu hình.

Ví dụ:

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,
});

JavaScript (cũ)

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,
});

Xem thêm

• Định cấu hình chế độ cài đặt quyền riêng tư
• Hiển thị quảng cáo bị hạn chế

Thông số
privacySettings: PrivacySettingsConfig	Đối tượng chứa cấu hình chế độ cài đặt quyền riêng tư.

Giá trị trả về
PubAdsService	Đối tượng dịch vụ mà hàm được gọi.

---

setPublisherProvidedId

setPublisherProvidedId(ppid: string): PubAdsService

Đặt giá trị cho mã nhận dạng do nhà xuất bản cung cấp.

Ví dụ:

JavaScript

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

JavaScript (cũ)

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

TypeScript

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

Xem thêm

• Giới thiệu về giá trị nhận dạng do nhà xuất bản cung cấp

Thông số
ppid: string	Mã chứa chữ và số do nhà xuất bản cung cấp. Phải có từ 32 đến 150 ký tự.

Giá trị trả về
PubAdsService	Đối tượng dịch vụ mà phương thức được gọi.

---

setSafeFrameConfig

setSafeFrameConfig(config: SafeFrameConfig): PubAdsService

Đặt các lựa chọn ưu tiên ở cấp trang cho cấu hình SafeFrame. Mọi khoá không nhận dạng được trong đối tượng cấu hình sẽ bị bỏ qua. Toàn bộ cấu hình sẽ bị bỏ qua nếu một giá trị không hợp lệ được truyền cho một khoá được nhận dạng.

Các lựa chọn ưu tiên ở cấp trang này sẽ bị ghi đè bởi các lựa chọn ưu tiên ở cấp vùng quảng cáo (nếu được chỉ định).

Không dùng nữa: Hãy sử dụng PageSettingsConfig.safeFrame.

Ví dụ:

JavaScript

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 (cũ)

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");

Xem thêm

• Hiển thị mẫu quảng cáo bằng SafeFrame

Thông số
config: SafeFrameConfig	Đối tượng cấu hình.

Giá trị trả về
PubAdsService	Đối tượng dịch vụ mà phương thức được gọi.

---

setTargeting

setTargeting(key: string, value: string | string[]): PubAdsService

Đặt các thông số nhắm mục tiêu tuỳ chỉnh cho một khoá nhất định áp dụng cho tất cả các vùng quảng cáo của dịch vụ Quảng cáo của nhà xuất bản. Việc gọi phương thức này nhiều lần cho cùng một khoá sẽ ghi đè các giá trị cũ. Các khoá này được xác định trong tài khoản Google Ad Manager của bạn.

Không dùng nữa: Thay vào đó, hãy sử dụng PageSettingsConfig.targeting.

Ví dụ:

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"]);

JavaScript (cũ)

// 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"]);

Xem thêm

• Nhắm mục tiêu khoá-giá trị

Thông số
key: string	Khoá thông số nhắm mục tiêu.
value: string | string[]	Giá trị tham số nhắm mục tiêu hoặc mảng giá trị.

Giá trị trả về
PubAdsService	Đối tượng dịch vụ mà phương thức được gọi.

---

setVideoContent

setVideoContent(videoContentId: string, videoCmsId: string): void

Đặt thông tin về nội dung video sẽ được gửi cùng với các yêu cầu quảng cáo cho mục đích nhắm mục tiêu và loại trừ nội dung. Quảng cáo dạng video sẽ tự động được bật khi phương thức này được gọi. Đối với videoContentId và videoCmsId, hãy sử dụng các giá trị được cung cấp cho dịch vụ nhập nội dung của Google Ad Manager.

Không dùng nữa: Thay vào đó, hãy sử dụng PageSettingsConfig.videoAds.

Xem thêm

• Thông số URL của thẻ quảng cáo VAST

Thông số
videoContentId: string	Mã nội dung video.
videoCmsId: string	Mã nhận dạng CMS của video.

---

updateCorrelator

updateCorrelator(): PubAdsService

Thay đổi giá trị tương quan được gửi cùng với các yêu cầu quảng cáo, từ đó bắt đầu một lượt xem trang mới. Giá trị tương quan là giống nhau cho tất cả các yêu cầu quảng cáo đến từ một lượt xem trang và là duy nhất trên các lượt xem trang. Chỉ áp dụng cho chế độ không đồng bộ.

Lưu ý: chế độ này không ảnh hưởng đến lượt xem trang tồn tại lâu dài của GPT. Lượt xem trang này tự động phản ánh những quảng cáo thực tế trên trang và không có thời gian hết hạn.

Ví dụ:

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.

JavaScript (cũ)

// 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.

Giá trị trả về
PubAdsService	Đối tượng dịch vụ mà hàm được gọi.

---

googletag.ResponseInformation

Một đối tượng đại diện cho một phản hồi quảng cáo.

Thuộc tính
advertiserId	Mã của nhà quảng cáo.
campaignId	Mã chiến dịch.
creativeId	Mã của mẫu quảng cáo.
creativeTemplateId	Mã mẫu của quảng cáo.
lineItemId	Mã nhận dạng của mục hàng.

Xem thêm

• Slot.getResponseInformation

Thuộc tính

---

advertiserId

advertiserId: number

Mã của nhà quảng cáo.

---

campaignId

campaignId: number

Mã chiến dịch.

---

creativeId

creativeId: number

Mã của mẫu quảng cáo.

---

creativeTemplateId

creativeTemplateId: number

Mã mẫu của quảng cáo.

---

lineItemId

lineItemId: number

Mã nhận dạng của mục hàng.

---

googletag.RewardedPayload

Một đối tượng đại diện cho phần thưởng liên kết với một quảng cáo có tặng thưởng

Thuộc tính
amount	Số lượng mặt hàng có trong phần thưởng.
type	Loại mặt hàng có trong phần thưởng (ví dụ: "xu").

Xem thêm

• Hiển thị quảng cáo có tặng thưởng

Thuộc tính

---

số tiền

amount: number

Số lượng mặt hàng có trong phần thưởng.

---

type

type: string

Loại mặt hàng có trong phần thưởng (ví dụ: "xu").

---

googletag.Service

Lớp dịch vụ cơ sở chứa các phương thức chung cho tất cả các dịch vụ.

Phương thức
addEventListener	Đăng ký một trình nghe cho phép bạn thiết lập và gọi một hàm JavaScript khi một sự kiện GPT cụ thể xảy ra trên trang.
getSlots	Lấy danh sách các khung giờ được liên kết với dịch vụ này.
removeEventListener	Xoá một trình nghe đã đăng ký trước đó.

Phương thức

---

addEventListener

addEventListener<K extends keyof EventTypeMap>(eventType: K, listener: ((arg: EventTypeMap[K]) => void)): Service

Đăng ký một trình nghe cho phép bạn thiết lập và gọi một hàm JavaScript khi một sự kiện GPT cụ thể xảy ra trên trang. Các sự kiện sau đây được hỗ trợ:

• events.GameManualInterstitialSlotClosedEvent
• events.GameManualInterstitialSlotReadyEvent
• events.ImpressionViewableEvent
• events.RewardedSlotClosedEvent
• events.RewardedSlotGrantedEvent
• events.RewardedSlotReadyEvent
• events.SlotOnloadEvent
• events.SlotRenderEndedEvent
• events.SlotRequestedEvent
• events.SlotResponseReceived
• events.SlotVisibilityChangedEvent

Một đối tượng thuộc loại sự kiện thích hợp sẽ được truyền đến trình nghe khi trình nghe được gọi.

Ví dụ:

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 (cũ)

// 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.
  }
});

Xem thêm

• Trình nghe sự kiện quảng cáo

Thông số
eventType: K	Một chuỗi biểu thị loại sự kiện do GPT tạo. Loại sự kiện có phân biệt chữ hoa chữ thường.
listener: ((arg: EventTypeMap[K]) => void)	Hàm nhận một đối số đối tượng sự kiện duy nhất.

Giá trị trả về
Service	Đối tượng dịch vụ mà phương thức được gọi.

---

getSlots

getSlots(): Slot[]

Lấy danh sách các khung giờ được liên kết với dịch vụ này.

Giá trị trả về
Slot[]	Các khung giờ theo thứ tự được thêm vào dịch vụ.

---

removeEventListener

removeEventListener<K extends keyof EventTypeMap>(eventType: K, listener: ((event: EventTypeMap[K]) => void)): void

Xoá một trình nghe đã đăng ký trước đó.

Ví dụ:

JavaScript

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 (cũ)

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();
});

Thông số
eventType: K	Một chuỗi biểu thị loại sự kiện do GPT tạo. Loại sự kiện có phân biệt chữ hoa chữ thường.
listener: ((event: EventTypeMap[K]) => void)	Hàm nhận một đối số đối tượng sự kiện duy nhất.

---

googletag.SizeMappingBuilder

Trình tạo cho các đối tượng chỉ định ánh xạ kích thước. Trình tạo này được cung cấp để giúp bạn dễ dàng tạo thông số kỹ thuật về kích thước.

Phương thức
addSize	Thêm một mối liên kết từ mảng có một kích thước (đại diện cho khung hiển thị) đến mảng có một hoặc nhiều kích thước đại diện cho vùng quảng cáo.
build	Tạo một quy cách bản đồ kích thước từ các mối liên kết được thêm vào trình tạo này.

Xem thêm

• Kích thước quảng cáo: Quảng cáo thích ứng

Phương thức

---

addSize

addSize(viewportSize: SingleSizeArray, slotSize: GeneralSize): SizeMappingBuilder

Thêm một mối liên kết từ mảng có một kích thước (đại diện cho khung hiển thị) đến mảng có một hoặc nhiều kích thước đại diện cho vùng quảng cáo.

Ví dụ:

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 < 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 (cũ)

// 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 < 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 < 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]

Thông số
viewportSize: SingleSizeArray	Kích thước khung nhìn cho mục nhập ánh xạ này.
slotSize: GeneralSize	Kích thước của vị trí cho mục nhập ánh xạ này.

Giá trị trả về
SizeMappingBuilder	Tham chiếu đến trình tạo này.

---

xây dựng

build(): SizeMappingArray

Tạo một quy cách bản đồ kích thước từ các mối liên kết được thêm vào trình tạo này.

Nếu bạn đã cung cấp bất kỳ mối liên kết không hợp lệ nào, phương thức này sẽ trả về null. Nếu không, hàm này sẽ trả về một quy cách ở định dạng chính xác để truyền đến Slot.defineSizeMapping.

Lưu ý: hành vi của trình tạo sau khi gọi phương thức này là không xác định.

Giá trị trả về
SizeMappingArray	Kết quả do trình tạo này tạo ra. Có thể là giá trị rỗng nếu bạn cung cấp các lệnh ánh xạ kích thước không hợp lệ.

---

googletag.Slot

Vùng quảng cáo là một đối tượng đại diện cho một vùng quảng cáo duy nhất trên một trang.

Phương thức
addService	Thêm một Dịch vụ vào vị trí này.
clearCategoryExclusions	Không dùng nữa. Xoá tất cả nhãn loại trừ danh mục quảng cáo ở cấp vùng cho vùng này.
clearTargeting	Không dùng nữa. Xoá các thông số nhắm mục tiêu tuỳ chỉnh cụ thể hoặc tất cả các thông số nhắm mục tiêu tuỳ chỉnh ở cấp độ vùng quảng cáo cho vùng quảng cáo này.
defineSizeMapping	Đặt một mảng các mối liên kết từ kích thước khung hiển thị tối thiểu đến kích thước vùng quảng cáo cho vùng quảng cáo này.
get	Không dùng nữa. Trả về giá trị cho thuộc tính AdSense được liên kết với khoá đã cho cho vùng quảng cáo này.
getAdUnitPath	Trả về đường dẫn đầy đủ của đơn vị quảng cáo, bao gồm mã mạng và đường dẫn đơn vị quảng cáo.
getAttributeKeys	Không dùng nữa. Trả về danh sách các khoá thuộc tính được đặt trên khe này.
getCategoryExclusions	Không dùng nữa. Trả về nhãn loại trừ danh mục quảng cáo cho vùng quảng cáo này.
getConfig	Lấy các lựa chọn cấu hình chung cho vị trí do setConfig đặt.
getResponseInformation	Trả về thông tin về nội dung phản hồi quảng cáo.
getSlotElementId	Trả về mã nhận dạng của vị trí div được cung cấp khi vị trí đó được xác định.
getTargeting	Không dùng nữa. Trả về một bộ thông số nhắm mục tiêu tuỳ chỉnh cụ thể được đặt trên khe này.
getTargetingKeys	Không dùng nữa. Trả về danh sách tất cả các khoá nhắm mục tiêu tuỳ chỉnh được đặt trên vị trí này.
set	Không dùng nữa. Đặt giá trị cho một thuộc tính AdSense trên vùng quảng cáo này.
setCategoryExclusion	Không dùng nữa. Đặt nhãn loại trừ danh mục quảng cáo ở cấp vị trí trên vị trí này.
setClickUrl	Không dùng nữa. Đặt URL nhấp chuột mà người dùng sẽ được chuyển hướng đến sau khi nhấp vào quảng cáo.
setCollapseEmptyDiv	Không dùng nữa. Đặt xem có nên ẩn vùng div khi không có quảng cáo trong vùng đó hay không.
setConfig	Đặt các lựa chọn cấu hình chung cho vị trí này.
setForceSafeFrame	Không dùng nữa. Định cấu hình xem quảng cáo trong vùng này có bắt buộc phải hiển thị bằng vùng chứa SafeFrame hay không.
setSafeFrameConfig	Không dùng nữa. Đặt các lựa chọn ưu tiên ở cấp vị trí cho cấu hình SafeFrame.
setTargeting	Không dùng nữa. Đặt một tham số nhắm mục tiêu tuỳ chỉnh cho vị trí này.
updateTargetingFromMap	Không dùng nữa. Đặt các thông số nhắm mục tiêu tuỳ chỉnh cho vị trí này, từ bản đồ khoá:giá trị trong một đối tượng JSON.

Phương thức

---

addService

addService(service: Service): Slot

Thêm một Dịch vụ vào vị trí này.

Ví dụ:

JavaScript

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

JavaScript (cũ)

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

TypeScript

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

Xem thêm

• Bắt đầu sử dụng Thẻ nhà xuất bản của Google
• Hiển thị quảng cáo thử nghiệm

Thông số
service: Service	Dịch vụ cần thêm.

Giá trị trả về
Slot	Đối tượng khe mà phương thức được gọi.

---

clearCategoryExclusions

clearCategoryExclusions(): Slot

Xoá tất cả nhãn loại trừ danh mục quảng cáo ở cấp vị trí cho vị trí này.

Không dùng nữa: Hãy sử dụng SlotSettingsConfig.categoryExclusion.

Ví dụ:

JavaScript

// 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 (cũ)

// 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.

Giá trị trả về
Slot	Đối tượng khe mà phương thức được gọi.

---

clearTargeting

clearTargeting(key?: string): Slot

Xoá các tham số nhắm mục tiêu tuỳ chỉnh cụ thể hoặc tất cả các tham số nhắm mục tiêu tuỳ chỉnh ở cấp độ vùng quảng cáo cho vùng quảng cáo này.

Không dùng nữa: Hãy sử dụng SlotSettingsConfig.targeting.

Ví dụ:

JavaScript

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 (cũ)

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.

Xem thêm

• Nhắm mục tiêu khoá-giá trị

Thông số
Optional key: string	Khoá thông số nhắm mục tiêu. Khoá này không bắt buộc; tất cả các thông số nhắm mục tiêu sẽ bị xoá nếu bạn không chỉ định.

Giá trị trả về
Slot	Đối tượng khe mà phương thức được gọi.

---

defineSizeMapping

defineSizeMapping(sizeMapping: SizeMappingArray): Slot

Đặt một mảng các mối liên kết từ kích thước khung hiển thị tối thiểu đến kích thước vùng quảng cáo cho vùng quảng cáo này.

Ví dụ:

JavaScript

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 (cũ)

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!);

Xem thêm

• Kích thước quảng cáo: Quảng cáo thích ứng

Thông số
sizeMapping: SizeMappingArray	Mảng ánh xạ kích thước. Bạn có thể sử dụng SizeMappingBuilder để tạo đối tượng này. Mỗi ánh xạ kích thước là một mảng gồm 2 phần tử: SingleSizeArray và GeneralSize.

Giá trị trả về
Slot	Đối tượng khe mà phương thức được gọi.

---

get

get(key: string): string

Trả về giá trị cho thuộc tính AdSense được liên kết với khoá đã cho cho vị trí này. Để xem các thuộc tính ở cấp dịch vụ mà vị trí này kế thừa, hãy sử dụng PubAdsService.get.

Không dùng nữa: Thay vào đó, hãy sử dụng googletag.Slot.getConfig.

Ví dụ:

JavaScript

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 (cũ)

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'.

Xem thêm

• Thuộc tính AdSense

Thông số
key: string	Tên của thuộc tính cần tìm.

Giá trị trả về
string	Giá trị hiện tại cho khoá thuộc tính hoặc null nếu khoá không có.

---

getAdUnitPath

getAdUnitPath(): string

Trả về đường dẫn đầy đủ của đơn vị quảng cáo, bao gồm mã mạng và đường dẫn đơn vị quảng cáo.

Ví dụ:

JavaScript

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

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

JavaScript (cũ)

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'.

Giá trị trả về
string	Đường dẫn đơn vị quảng cáo.

---

getAttributeKeys

getAttributeKeys(): string[]

Trả về danh sách các khoá thuộc tính được đặt trên khe này. Để xem các khoá thuộc tính cấp dịch vụ mà vị trí này kế thừa, hãy sử dụng PubAdsService.getAttributeKeys.

Không dùng nữa: Thay vào đó, hãy sử dụng googletag.Slot.getConfig.

Ví dụ:

JavaScript

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 (cũ)

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'].

Giá trị trả về
string[]	Mảng khoá thuộc tính. Thứ tự không xác định.

---

getCategoryExclusions

getCategoryExclusions(): string[]

Trả về nhãn loại trừ danh mục quảng cáo cho vùng này.

Không dùng nữa: Thay vào đó, hãy sử dụng googletag.Slot.getConfig.

Ví dụ:

JavaScript

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

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

JavaScript (cũ)

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'].

Giá trị trả về
string[]	Nhãn loại trừ danh mục quảng cáo cho vùng quảng cáo này hoặc một mảng trống nếu không có nhãn nào được đặt.

---

getConfig

getConfig(keys: string | string[]): Pick<SlotSettingsConfig, "adsenseAttributes" | "targeting" | "categoryExclusion">

Nhận các lựa chọn cấu hình chung cho vị trí do setConfig đặt.

Không phải tất cả các thuộc tính setConfig() đều được phương thức này hỗ trợ. Sau đây là các thuộc tính được hỗ trợ:

• adsenseAttributes
• categoryExclusion
• targeting

Ví dụ:

JavaScript

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 (cũ)

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"]);

Thông số
keys: string | string[]	Khoá của các lựa chọn cấu hình cần nhận.

Giá trị trả về
Pick<SlotSettingsConfig, "adsenseAttributes" | "targeting" | "categoryExclusion">	Các lựa chọn cấu hình cho khe.

---

getResponseInformation

getResponseInformation(): ResponseInformation

Trả về thông tin về nội dung phản hồi quảng cáo. Điều này dựa trên phản hồi quảng cáo gần đây nhất cho vị trí. Nếu phương thức này được gọi khi vùng quảng cáo không có quảng cáo, thì null sẽ được trả về.

Giá trị trả về
ResponseInformation	Thông tin mới nhất về phản hồi quảng cáo hoặc null nếu vị trí không có quảng cáo.

---

getSlotElementId

getSlotElementId(): string

Trả về mã nhận dạng của vùng quảng cáo div được cung cấp khi vùng quảng cáo được xác định.

Ví dụ:

JavaScript

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

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

JavaScript (cũ)

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'.

Giá trị trả về
string	Mã nhận dạng div của vị trí.

---

getTargeting

getTargeting(key: string): string[]

Trả về một tập hợp thông số nhắm mục tiêu tuỳ chỉnh cụ thể được đặt trên khe này. Không có các tham số nhắm mục tiêu ở cấp dịch vụ.

Không dùng nữa: Thay vào đó, hãy sử dụng googletag.Slot.getConfig.

Ví dụ:

JavaScript

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 (cũ)

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).

Thông số
key: string	Khoá nhắm mục tiêu cần tìm.

Giá trị trả về
string[]	Các giá trị được liên kết với khoá này hoặc một mảng trống nếu không có khoá như vậy.

---

getTargetingKeys

getTargetingKeys(): string[]

Trả về danh sách tất cả các khoá nhắm mục tiêu tuỳ chỉnh được đặt trên vị trí này. Không bao gồm các khoá nhắm mục tiêu ở cấp dịch vụ.

Không dùng nữa: Thay vào đó, hãy sử dụng googletag.Slot.getConfig.

Ví dụ:

JavaScript

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 (cũ)

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'].

Giá trị trả về
string[]	Mảng khoá nhắm mục tiêu. Thứ tự không xác định.

---

set

set(key: string, value: string): Slot

Đặt một giá trị cho thuộc tính AdSense trên vùng quảng cáo này. Thao tác này sẽ ghi đè mọi giá trị được đặt ở cấp dịch vụ cho khoá này.

Nếu bạn gọi phương thức này nhiều lần cho cùng một khoá, thì các giá trị đã đặt trước đó cho khoá đó sẽ bị ghi đè. Bạn phải đặt tất cả các giá trị trước khi gọi display hoặc refresh.

Không dùng nữa: Hãy sử dụng SlotSettingsConfig.adsenseAttributes.

Ví dụ:

JavaScript

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

JavaScript (cũ)

// 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());

Xem thêm

• Thuộc tính AdSense

Thông số
key: string	Tên của thuộc tính.
value: string	Giá trị thuộc tính.

Giá trị trả về
Slot	Đối tượng khe mà phương thức được gọi.

---

setCategoryExclusion

setCategoryExclusion(categoryExclusion: string): Slot

Đặt nhãn loại trừ danh mục quảng cáo cấp vị trí trên vị trí này.

Không dùng nữa: Hãy sử dụng SlotSettingsConfig.categoryExclusion.

Ví dụ:

JavaScript

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

JavaScript (cũ)

// 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());

Xem thêm

• Nhãn tuỳ chỉnh để chặn quảng cáo

Thông số
categoryExclusion: string	Nhãn loại trừ danh mục quảng cáo cần thêm.

Giá trị trả về
Slot	Đối tượng khe mà phương thức được gọi.

---

setClickUrl

setClickUrl(value: string): Slot

Đặt URL nhấp chuột mà người dùng sẽ được chuyển hướng đến sau khi nhấp vào quảng cáo.

Các máy chủ Google Ad Manager vẫn ghi lại lượt nhấp ngay cả khi URL nhấp chuột được thay thế. Mọi URL trang đích được liên kết với mẫu quảng cáo được phân phát đều được thêm vào giá trị được cung cấp. Các lệnh gọi tiếp theo sẽ ghi đè giá trị. Chế độ này chỉ hoạt động đối với các yêu cầu không phải SRA.

Không dùng nữa: Thay vào đó, hãy sử dụng SlotSettingsConfig.clickUrl.

Ví dụ:

JavaScript

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

JavaScript (cũ)

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());

Thông số
value: string	URL nhấp chuột cần thiết lập.

Giá trị trả về
Slot	Đối tượng khe mà phương thức được gọi.

---

setCollapseEmptyDiv

setCollapseEmptyDiv(collapse: boolean, collapseBeforeAdFetch?: boolean): Slot

Đặt xem có nên ẩn vùng div khi không có quảng cáo trong vùng này hay không. Thao tác này sẽ ghi đè các chế độ cài đặt ở cấp dịch vụ.

Không dùng nữa: Sử dụng SlotSettingsConfig.collapseDiv để thay thế.

Ví dụ:

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.

JavaScript (cũ)

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.

Xem thêm

• Thu gọn vùng quảng cáo trống
• Giảm thiểu mức thay đổi bố cục

Thông số
collapse: boolean	Có thu gọn vùng quảng cáo hay không nếu không có quảng cáo nào được trả về.
Optional collapseBeforeAdFetch: boolean	Có thu gọn vùng quảng cáo hay không, ngay cả trước khi quảng cáo được tìm nạp. Bỏ qua nếu collapse không phải là true.

Giá trị trả về
Slot	Đối tượng khe mà phương thức được gọi.

---

setConfig

setConfig(slotConfig: SlotSettingsConfig): void

Đặt các lựa chọn cấu hình chung cho vị trí này.

Thông số
slotConfig: SlotSettingsConfig	Đối tượng cấu hình.

---

setForceSafeFrame

setForceSafeFrame(forceSafeFrame: boolean): Slot

Định cấu hình xem quảng cáo trong vùng này có bắt buộc phải hiển thị bằng vùng chứa SafeFrame hay không.

Vui lòng lưu ý những điều sau đây khi sử dụng API này:

• Chế độ cài đặt này sẽ chỉ có hiệu lực đối với các yêu cầu quảng cáo tiếp theo được thực hiện cho các vị trí tương ứng.
• Nếu được chỉ định, chế độ cài đặt cấp vùng quảng cáo sẽ luôn ghi đè chế độ cài đặt cấp trang.
• Nếu được đặt thành true (ở cấp độ vùng quảng cáo hoặc cấp độ trang), quảng cáo sẽ luôn được hiển thị bằng vùng chứa SafeFrame, bất kể lựa chọn nào được đưa ra trong giao diện người dùng Google Ad Manager.
• Tuy nhiên, nếu được đặt thành false hoặc không được chỉ định, quảng cáo sẽ được hiển thị bằng vùng chứa SafeFrame tuỳ thuộc vào loại mẫu quảng cáo và lựa chọn được thực hiện trong giao diện người dùng Google Ad Manager.
• Bạn nên sử dụng API này một cách thận trọng vì API này có thể ảnh hưởng đến hành vi của những mẫu quảng cáo cố gắng thoát khỏi iFrame hoặc dựa vào việc các mẫu quảng cáo đó được hiển thị trực tiếp trong trang của nhà xuất bản.

Không dùng nữa: Thay vào đó, hãy sử dụng SlotSettingsConfig.safeFrame.

Ví dụ:

JavaScript

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

JavaScript (cũ)

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());

Xem thêm

• Hiển thị mẫu quảng cáo bằng SafeFrame

Thông số
forceSafeFrame: boolean	true để buộc tất cả quảng cáo trong vùng này được hiển thị trong SafeFrame và false để chọn không sử dụng chế độ cài đặt ở cấp trang (nếu có). Việc đặt giá trị này thành false khi không được chỉ định ở cấp trang sẽ không thay đổi bất cứ điều gì.

Giá trị trả về
Slot	Đối tượng khe mà phương thức được gọi.

---

setSafeFrameConfig

setSafeFrameConfig(config: SafeFrameConfig): Slot

Đặt các lựa chọn ưu tiên ở cấp vị trí cho cấu hình SafeFrame. Mọi khoá không nhận dạng được trong đối tượng cấu hình sẽ bị bỏ qua. Toàn bộ cấu hình sẽ bị bỏ qua nếu một giá trị không hợp lệ được truyền cho một khoá được nhận dạng.

Các lựa chọn ưu tiên ở cấp độ vùng quảng cáo này (nếu được chỉ định) sẽ ghi đè mọi lựa chọn ưu tiên ở cấp độ trang.

Không dùng nữa: Thay vào đó, hãy sử dụng SlotSettingsConfig.safeFrame.

Ví dụ:

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");

JavaScript (cũ)

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");

Xem thêm

• Hiển thị mẫu quảng cáo bằng SafeFrame

Thông số
config: SafeFrameConfig	Đối tượng cấu hình.

Giá trị trả về
Slot	Đối tượng khe mà phương thức được gọi.

---

setTargeting

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

Đặt một tham số nhắm mục tiêu tuỳ chỉnh cho vị trí này. Việc gọi phương thức này nhiều lần cho cùng một khoá sẽ ghi đè các giá trị cũ. Các giá trị được đặt ở đây sẽ ghi đè các thông số nhắm mục tiêu được đặt ở cấp dịch vụ. Các khoá này được xác định trong tài khoản Google Ad Manager của bạn.

Không dùng nữa: Hãy sử dụng SlotSettingsConfig.targeting.

Ví dụ:

JavaScript

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 (cũ)

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"]);

Xem thêm

• Nhắm mục tiêu khoá-giá trị

Thông số
key: string	Khoá thông số nhắm mục tiêu.
value: string | string[]	Giá trị tham số nhắm mục tiêu hoặc mảng giá trị.

Giá trị trả về
Slot	Đối tượng khe mà phương thức được gọi.

---

updateTargetingFromMap

updateTargetingFromMap(map: {
  [adUnitPath: string]: string | string[];
}): Slot

Đặt các tham số nhắm mục tiêu tuỳ chỉnh cho vị trí này, từ một bản đồ khoá:giá trị trong đối tượng JSON. Thao tác này tương tự như việc gọi Slot.setTargeting cho tất cả các giá trị khoá của đối tượng. Các khoá này được xác định trong tài khoản Google Ad Manager của bạn.

Lưu ý:

• Trong trường hợp ghi đè, hệ thống sẽ chỉ giữ lại giá trị cuối cùng.
• Nếu giá trị là một mảng, thì mọi giá trị trước đó sẽ bị ghi đè chứ không được hợp nhất.
• Các giá trị được đặt ở đây sẽ ghi đè các thông số nhắm mục tiêu được đặt ở cấp dịch vụ.

Không dùng nữa: Thay vào đó, hãy sử dụng SlotSettingsConfig.targeting.

Ví dụ:

JavaScript

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

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

JavaScript (cũ)

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"],
});

Thông số
map: {   [adUnitPath: string]: string | string[]; }	Bản đồ khoá:giá trị của tham số nhắm mục tiêu.

Giá trị trả về
Slot	Đối tượng khe mà phương thức được gọi.

---

googletag.config

Giao diện cấu hình chính cho chế độ cài đặt cấp trang.

Giao diện
AdExpansionConfig	Chế độ cài đặt để kiểm soát việc mở rộng quảng cáo.
AdSenseAttributesConfig	Các chế độ cài đặt để kiểm soát hành vi của quảng cáo AdSense.
ComponentAuctionConfig	Một đối tượng đại diện cho một phiên đấu giá thành phần trong phiên đấu giá quảng cáo trên thiết bị.
InterstitialConfig	Một đối tượng xác định hành vi của một vị trí quảng cáo xen kẽ.
LazyLoadConfig	Các chế độ cài đặt để kiểm soát việc sử dụng tính năng tải từng phần trong GPT.
PageSettingsConfig	Giao diện cấu hình chính cho chế độ cài đặt cấp trang.
PrivacyTreatmentsConfig	Các chế độ cài đặt để kiểm soát cách xử lý quyền riêng tư của nhà xuất bản.
PublisherProvidedSignalsConfig	Đối tượng cấu hình tín hiệu do nhà xuất bản cung cấp (PPS).
SafeFrameConfig	Các chế độ cài đặt để kiểm soát SafeFrame trong GPT.
SlotSettingsConfig	Giao diện cấu hình chính cho các chế độ cài đặt ở cấp vị trí.
TaxonomyData	Một đối tượng chứa các giá trị cho một Phân loại duy nhất.
VideoAdsConfig	Chế độ cài đặt để định cấu hình các chế độ cài đặt liên quan đến quảng cáo dạng video.

Bí danh loại
CollapseDivBehavior	Các giá trị được hỗ trợ để kiểm soát hành vi thu gọn của các vị trí quảng cáo.
InterstitialTrigger	Các điều kiện kích hoạt quảng cáo xen kẽ được hỗ trợ.
PrivacyTreatment	Các cách xử lý quyền riêng tư được hỗ trợ cho nhà xuất bản.
Taxonomy	Hệ thống phân loại được hỗ trợ cho tín hiệu do nhà xuất bản cung cấp (PPS).

Bí danh loại

---

CollapseDivBehavior

CollapseDivBehavior: "DISABLED" | "BEFORE_FETCH" | "ON_NO_FILL"

Các giá trị được hỗ trợ để kiểm soát hành vi thu gọn của các vị trí quảng cáo.

Xem thêm

• PageSettingsConfig.collapseDiv
• SlotSettingsConfig.collapseDiv

---

InterstitialTrigger

InterstitialTrigger: "unhideWindow" | "navBar"

Các điều kiện kích hoạt quảng cáo xen kẽ được hỗ trợ.

---

PrivacyTreatment

PrivacyTreatment: "disablePersonalization"

Các cách xử lý quyền riêng tư được hỗ trợ cho nhà xuất bản.

---

Phân loại

Taxonomy: "IAB_AUDIENCE_1_1" | "IAB_CONTENT_2_2"

Hệ thống phân loại được hỗ trợ cho tín hiệu do nhà xuất bản cung cấp (PPS).

Xem thêm

• Hệ thống phân loại đối tượng theo IAB 1.1
• Hệ thống phân loại nội dung 2.2 của IAB

---

googletag.config.AdExpansionConfig

Chế độ cài đặt để kiểm soát việc mở rộng quảng cáo.

Thuộc tính
enabled?	Tính năng mở rộng quảng cáo đang bật hay tắt.

Ví dụ:

JavaScript

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

JavaScript (cũ)

// 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 },
});

Thuộc tính

---

Optional đã bật

enabled?: boolean

Có bật hay tắt tính năng mở rộng quảng cáo.

Việc đặt giá trị này sẽ ghi đè giá trị mặc định được định cấu hình trong Google Ad Manager.

Xem thêm

• Mở rộng quảng cáo trên máy tính và máy tính bảng
• Mở rộng quảng cáo trên web dành cho thiết bị di động (một phần màn hình)

---

googletag.config.AdSenseAttributesConfig

Chế độ cài đặt để kiểm soát hành vi của quảng cáo AdSense.

Bạn có thể dùng các thuộc tính này để ghi đè chế độ cài đặt phía máy chủ theo từng yêu cầu.

Thuộc tính
adsense_ad_format?	Định dạng quảng cáo AdSense.
adsense_channel_ids?	Mã kênh AdSense.
adsense_test_mode?	Chế độ thử nghiệm có được bật hay không.
document_language?	Ngôn ngữ của trang mà quảng cáo được hiển thị.
page_url?	URL của trang mà quảng cáo được hiển thị.

Xem thêm

• PageSettingsConfig.adsenseAttributes
• SlotSettingsConfig.adsenseAttributes

Thuộc tính

---

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"

Định dạng quảng cáo AdSense.

---

Optional adsense_channel_ids

adsense_channel_ids?: string

Mã kênh AdSense.

Các giá trị được cho phép là mã kênh được phân tách bằng dấu "+".

Ví dụ: 271828183+314159265

Xem thêm

• Theo dõi hiệu suất của đơn vị quảng cáo bằng kênh tuỳ chỉnh

---

Optional adsense_test_mode

adsense_test_mode?: "on"

Chế độ thử nghiệm có được bật hay không.

Khi được đặt thành on, quảng cáo sẽ được đánh dấu là chỉ dành cho thử nghiệm và sẽ không được tính vào số lượt hiển thị hoặc tính phí. Bạn phải huỷ đặt chế độ cài đặt này cho lưu lượng truy cập chính thức, không phải lưu lượng truy cập thử nghiệm.

---

Optional document_language

document_language?: string

Ngôn ngữ của trang mà quảng cáo xuất hiện.

Giá trị được phép là mã ngôn ngữ ISO 639-1 hợp lệ.

Ví dụ: en

Xem thêm

• Danh sách mã ngôn ngữ ISO 639

---

Optional page_url

page_url?: string

URL của trang mà quảng cáo hiển thị.

Giá trị được phép là URL hợp lệ.

Ví dụ: http://www.example.com

---

googletag.config.ComponentAuctionConfig

Một đối tượng đại diện cho một phiên đấu giá thành phần trong phiên đấu giá quảng cáo trên thiết bị.

Thuộc tính
auctionConfig	Một đối tượng cấu hình đấu giá cho phiên đấu giá thành phần này.
configKey	Khoá cấu hình được liên kết với phiên đấu giá thành phần này.

Xem thêm

• Hướng dẫn dành cho người bán Protected Audience API: chạy phiên đấu giá quảng cáo

Thuộc tính

---

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;
}

Một đối tượng cấu hình đấu giá cho phiên đấu giá thành phần này.

Nếu giá trị này được đặt thành null, mọi cấu hình hiện có cho configKey được chỉ định sẽ bị xoá.

Ví dụ:

JavaScript

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 (cũ)

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,
    },
  ],
});

Xem thêm

• Protected Audience API: Bắt đầu phiên đấu giá trên thiết bị

---

configKey

configKey: string

Khoá cấu hình được liên kết với phiên đấu giá thành phần này.

Giá trị này không được để trống và phải là giá trị duy nhất. Nếu hai đối tượng ComponentAuctionConfig có cùng giá trị configKey, thì đối tượng được đặt sau cùng sẽ ghi đè các cấu hình trước đó.

---

googletag.config.InterstitialConfig

Một đối tượng xác định hành vi của một vị trí quảng cáo xen kẽ.

Thuộc tính
requireStorageAccess?	Liệu có cần có sự đồng ý để truy cập vào bộ nhớ cục bộ để hiển thị quảng cáo xen kẽ này hay không.
triggers?	Cấu hình điều kiện kích hoạt quảng cáo xen kẽ cho quảng cáo xen kẽ này.

Thuộc tính

---

Optional requireStorageAccess

requireStorageAccess?: boolean

Bạn có cần phải có sự đồng ý cho bộ nhớ cục bộ để hiển thị quảng cáo xen kẽ này hay không.

GPT sử dụng bộ nhớ cục bộ để thực thi giới hạn tần suất cho quảng cáo xen kẽ. Tuy nhiên, những người dùng chưa đồng ý cho phép truy cập vào bộ nhớ cục bộ vẫn đủ điều kiện để được phân phát quảng cáo xen kẽ. Việc đặt thuộc tính này thành true sẽ chọn không sử dụng hành vi mặc định và đảm bảo rằng quảng cáo xen kẽ chỉ hiển thị cho những người dùng đã đồng ý lưu trữ cục bộ.

Ví dụ:

JavaScript

// 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 (cũ)

// 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
  },
});

Xem thêm

• Quảng cáo xen kẽ trên web để tăng lưu lượng truy cập

---

Optional điều kiện kích hoạt

triggers?: Partial<Record<InterstitialTrigger, boolean>>

Cấu hình điều kiện kích hoạt quảng cáo xen kẽ cho quảng cáo xen kẽ này.

Đặt giá trị của điều kiện kích hoạt quảng cáo xen kẽ thành true để bật và false để tắt. Thao tác này sẽ ghi đè các giá trị mặc định được định cấu hình trong Google Ad Manager.

Ví dụ:

JavaScript

// 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 (cũ)

// 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,
    },
  },
});

Xem thêm

• Hiển thị quảng cáo xen kẽ trên web

---

googletag.config.LazyLoadConfig

Các chế độ cài đặt để kiểm soát việc sử dụng tính năng tải từng phần trong GPT.

Thuộc tính
fetchMarginPercent?	Khoảng cách tối thiểu từ khung hiển thị hiện tại mà một vùng quảng cáo phải có trước khi chúng tôi yêu cầu một quảng cáo, được biểu thị bằng tỷ lệ phần trăm kích thước khung hiển thị.
mobileScaling?	Hệ số được áp dụng cho lề trên thiết bị di động.
renderMarginPercent?	Khoảng cách tối thiểu từ khung nhìn hiện tại mà một vị trí phải có trước khi chúng tôi hiển thị quảng cáo, được biểu thị bằng tỷ lệ phần trăm kích thước khung nhìn.

Xem thêm

• PageSettingsConfig.lazyLoad

Thuộc tính

---

Optional fetchMarginPercent

fetchMarginPercent?: number

Khoảng cách tối thiểu từ khung hiển thị hiện tại mà một vùng quảng cáo phải có trước khi chúng tôi yêu cầu quảng cáo, được biểu thị bằng tỷ lệ phần trăm kích thước khung hiển thị.

Được dùng kết hợp với renderMarginPercent, chế độ cài đặt này cho phép tìm nạp trước một quảng cáo, nhưng chờ hiển thị và tải các tài nguyên phụ khác xuống. Do đó, giá trị này phải luôn lớn hơn hoặc bằng renderMarginPercent.

Giá trị 0 có nghĩa là "khi vị trí này xuất hiện trong khung hiển thị", 100 có nghĩa là "khi quảng cáo cách khung hiển thị 1 khoảng", v.v.

---

Optional mobileScaling

mobileScaling?: number

Hệ số được áp dụng cho lề trên thiết bị di động. Hệ số nhân này được áp dụng cho cả fetchMarginPercent và renderMarginPercent.

Điều này cho phép bạn đặt các lề khác nhau trên thiết bị di động và máy tính, trong đó kích thước khung nhìn và tốc độ cuộn có thể khác nhau. Ví dụ: giá trị 2.0 sẽ nhân tất cả các lề với 2 trên thiết bị di động, làm tăng khoảng cách tối thiểu mà một ô có thể cách khung hiển thị trước khi tìm nạp và hiển thị.

---

Optional renderMarginPercent

renderMarginPercent?: number

Khoảng cách tối thiểu từ khung hiển thị hiện tại mà một vùng quảng cáo phải có trước khi chúng tôi hiển thị quảng cáo, được biểu thị bằng tỷ lệ phần trăm kích thước khung hiển thị.

Được dùng cùng với fetchMarginPercent, chế độ cài đặt này cho phép tìm nạp trước một quảng cáo, nhưng chờ hiển thị và tải các tài nguyên phụ khác xuống. Do đó, giá trị này phải luôn nhỏ hơn hoặc bằng fetchMarginPercent.

Giá trị 0 có nghĩa là "khi vị trí này xuất hiện trong khung hiển thị", 100 có nghĩa là "khi quảng cáo cách khung hiển thị 1 khoảng", v.v.

---

googletag.config.PageSettingsConfig

Giao diện cấu hình chính cho các chế độ cài đặt ở cấp trang.

Cho phép thiết lập nhiều tính năng bằng một lệnh gọi API duy nhất.

Tất cả các thuộc tính được liệt kê dưới đây đều là ví dụ và không phản ánh các tính năng thực tế sử dụng setConfig. Để biết tập hợp các tính năng, hãy xem các trường trong loại PageSettingsConfig bên dưới.

Ví dụ:

• Chỉ những tính năng được chỉ định trong lệnh gọi googletag.setConfig mới được sửa đổi.

    // Configure feature alpha.
    googletag.setConfig({
        alpha: {...}
    });
  
    // Configure feature bravo. Feature alpha is unchanged.
    googletag.setConfig({
       bravo: {...}
    });

• Tất cả các chế độ cài đặt cho một tính năng nhất định sẽ được cập nhật theo mỗi lệnh gọi đến 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
        }
    });

• Bạn có thể xoá tất cả chế độ cài đặt cho một tính năng bằng cách truyền 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,
    });

Thuộc tính
adExpansion?	Chế độ cài đặt để kiểm soát việc mở rộng quảng cáo.
adsenseAttributes?	Chế độ cài đặt để định cấu hình các thuộc tính AdSense.
adYield?	Không dùng nữa.
categoryExclusion?	Chế độ cài đặt để định cấu hình tiêu chí loại trừ danh mục quảng cáo.
centering?	Chế độ cài đặt để kiểm soát việc căn giữa quảng cáo theo chiều ngang.
collapseDiv?	Chế độ cài đặt để kiểm soát hành vi thu gọn của các vị trí quảng cáo.
disableInitialLoad?	Chế độ cài đặt để kiểm soát thời điểm yêu cầu quảng cáo.
lazyLoad?	Các chế độ cài đặt để kiểm soát việc sử dụng tính năng tải từng phần trong GPT.
location?	Chế độ cài đặt để nhắm mục tiêu địa lý cho các mục hàng theo vị trí địa lý.
pps?	Chế độ cài đặt để kiểm soát tín hiệu do nhà xuất bản cung cấp (PPS).
privacyTreatments?	Các chế độ cài đặt để kiểm soát cách xử lý quyền riêng tư của nhà xuất bản.
safeFrame?	Các chế độ cài đặt để kiểm soát việc sử dụng SafeFrame trong GPT.
singleRequest?	Chế độ cài đặt để bật hoặc tắt Cấu trúc yêu cầu duy nhất (SRA).
targeting?	Chế độ cài đặt để kiểm soát tiêu chí nhắm mục tiêu khoá-giá trị.
threadYield?	Chế độ cài đặt để kiểm soát việc GPT có nên tạo luồng JS khi yêu cầu và hiển thị mẫu quảng cáo hay không.
videoAds?	Chế độ cài đặt để kiểm soát quảng cáo dạng video.

Thuộc tính

---

Optional adExpansion

adExpansion?: AdExpansionConfig

Chế độ cài đặt để kiểm soát việc mở rộng quảng cáo.

---

Optional adsenseAttributes

adsenseAttributes?: AdSenseAttributesConfig

Chế độ cài đặt để định cấu hình các thuộc tính AdSense.

Các thuộc tính AdSense được định cấu hình thông qua chế độ cài đặt này sẽ áp dụng cho tất cả các vùng quảng cáo trên trang. Bạn có thể gọi chế độ cài đặt này nhiều lần để xác định nhiều giá trị thuộc tính hoặc ghi đè các giá trị hiện có.

Các thay đổi về thuộc tính AdSense chỉ áp dụng cho những quảng cáo được yêu cầu sau khi phương thức này được gọi. Vì lý do đó, bạn nên gọi phương thức này trước khi gọi googletag.display hoặc PubAdsService.refresh.

Ví dụ:

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 });

JavaScript (cũ)

// 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"

Không dùng nữa: Thay vào đó, hãy sử dụng threadYield. Chúng tôi sẽ xoá tính năng này trong tương lai gần.

---

Optional categoryExclusion

categoryExclusion?: string[]

Chế độ cài đặt để định cấu hình quy tắc loại trừ danh mục quảng cáo.

Ví dụ:

JavaScript

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

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

JavaScript (cũ)

// 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 });

Xem thêm

• Nhãn tuỳ chỉnh để chặn quảng cáo

---

Optional căn giữa

centering?: boolean

Chế độ cài đặt để kiểm soát việc căn giữa quảng cáo theo chiều ngang. Tính năng căn giữa bị tắt theo mặc định.

Các thay đổi về căn giữa theo chiều ngang chỉ áp dụng cho những quảng cáo được yêu cầu sau khi phương thức này được gọi. Vì lý do đó, bạn nên gọi phương thức này trước khi gọi googletag.display hoặc PubAdsService.refresh.

Ví dụ:

JavaScript

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

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

JavaScript (cũ)

// 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

Chế độ cài đặt để kiểm soát hành vi thu gọn của các vùng quảng cáo.

Vùng quảng cáo bị thu gọn sẽ không chiếm bất kỳ không gian nào trên trang.

Giá trị được hỗ trợ:

• null (mặc định): Vị trí sẽ không bị thu gọn.
• DISABLED: Vùng quảng cáo sẽ không thu gọn, bất kể quảng cáo có được trả về hay không.
• BEFORE_FETCH: Vùng quảng cáo sẽ bắt đầu ở trạng thái thu gọn và mở rộng khi quảng cáo được trả về.
• ON_NO_FILL: Vùng quảng cáo sẽ bắt đầu ở trạng thái mở rộng và thu gọn nếu không có quảng cáo nào được trả về.

Ví dụ:

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 });

JavaScript (cũ)

// 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 });

Xem thêm

• Thu gọn vùng quảng cáo trống
• Giảm thiểu mức thay đổi bố cục

---

Optional disableInitialLoad

disableInitialLoad?: boolean

Chế độ cài đặt để kiểm soát thời điểm yêu cầu quảng cáo.

Theo mặc định, phương thức googletag.display vừa đăng ký các vị trí quảng cáo vừa yêu cầu quảng cáo cho các vị trí đó. Tuy nhiên, đôi khi bạn nên tách riêng các thao tác này để kiểm soát chính xác hơn thời điểm tải nội dung quảng cáo.

Khi bạn bật chế độ cài đặt này, quảng cáo sẽ không được yêu cầu cho các vị trí đã đăng ký khi phương thức display() được gọi. Thay vào đó, bạn phải thực hiện một lệnh gọi riêng biệt đến PubAdsService.refresh để bắt đầu một yêu cầu quảng cáo.

Bạn phải gọi phương thức này trước khi gọi googletag.enableServices.

Ví dụ:

JavaScript

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

JavaScript (cũ)

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

TypeScript

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

Xem thêm

• Kiểm soát việc tải và làm mới quảng cáo
• Kiểm soát việc tạo lô SRA

---

Optional lazyLoad

lazyLoad?: LazyLoadConfig

Các chế độ cài đặt để kiểm soát việc sử dụng tính năng tải từng phần trong GPT.

Tải từng phần là một kỹ thuật trì hoãn việc yêu cầu và hiển thị quảng cáo cho đến khi quảng cáo vào khung nhìn của người dùng. Để xem ví dụ chi tiết hơn, hãy xem mẫu Tải từng phần.

Lưu ý: Nếu singleRequest được bật, thì tính năng tìm nạp từng phần chỉ hoạt động khi tất cả các khe đều nằm ngoài lề tìm nạp.

Mọi chế độ cài đặt tải từng phần không được chỉ định khi gọi setConfig() sẽ sử dụng giá trị mặc định do Google đặt. Những giá trị mặc định này có thể được điều chỉnh theo thời gian. Để tắt một chế độ cài đặt cụ thể, hãy đặt giá trị thành null.

Ví dụ:

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 });

JavaScript (cũ)

// 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 });

Xem thêm

• Các phương pháp hay nhất về quảng cáo: Ưu tiên các vị trí quảng cáo "quan trọng"
• Tải từng phần

---

Optional vị trí

location?: string

Chế độ cài đặt để nhắm mục tiêu theo vị trí địa lý cho các mục hàng.

Ví dụ:

JavaScript

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

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

JavaScript (cũ)

// 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 });

Xem thêm

• Nhắm mục tiêu theo vị trí địa lý để phân phối

---

Optional pps

pps?: PublisherProvidedSignalsConfig

Chế độ cài đặt để kiểm soát tín hiệu do nhà xuất bản cung cấp (PPS).

---

Optional privacyTreatments

privacyTreatments?: PrivacyTreatmentsConfig

Các chế độ cài đặt để kiểm soát cách xử lý quyền riêng tư của nhà xuất bản.

---

Optional safeFrame

safeFrame?: SafeFrameConfig

Chế độ cài đặt để kiểm soát việc sử dụng SafeFrame trong GPT.

Các giá trị được định cấu hình thông qua chế độ cài đặt này sẽ áp dụng cho tất cả các vùng quảng cáo trên trang. Các vị trí quảng cáo riêng lẻ có thể ghi đè những giá trị này thông qua SlotSettingsConfig.safeFrame.

Ví dụ:

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 });

JavaScript (cũ)

// 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

Chế độ cài đặt để bật hoặc tắt Cấu trúc yêu cầu duy nhất (SRA).

Khi SRA được bật, tất cả các vùng quảng cáo được xác định trước một lệnh gọi googletag.display hoặc PubAdsService.refresh sẽ được gộp vào một yêu cầu quảng cáo duy nhất. Điều này mang lại lợi ích về hiệu suất, nhưng cũng cần thiết để đảm bảo các quy tắc loại trừ cạnh tranh và roadblock được tuân thủ.

Khi SRA bị tắt, mỗi vị trí quảng cáo sẽ được yêu cầu riêng lẻ. Đây là hành vi mặc định của GPT.

Bạn phải gọi phương thức này trước khi gọi googletag.enableServices.

Ví dụ:

JavaScript

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

JavaScript (cũ)

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

TypeScript

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

Xem thêm

• Giới thiệu về roadblock
• Các phương pháp hay nhất về quảng cáo: Sử dụng Cấu trúc yêu cầu duy nhất một cách chính xác
• Kiểm soát việc tạo lô SRA

---

Optional nhắm mục tiêu

targeting?: Record<string, string | string[]>

Chế độ cài đặt để kiểm soát tiêu chí nhắm mục tiêu bằng khoá-giá trị.

Tiêu chí nhắm mục tiêu được định cấu hình thông qua chế độ cài đặt này sẽ áp dụng cho tất cả vùng quảng cáo trên trang. Bạn có thể gọi chế độ cài đặt này nhiều lần để xác định nhiều khoá-giá trị nhắm mục tiêu hoặc ghi đè các giá trị hiện có. Khoá nhắm mục tiêu được xác định trong tài khoản Google Ad Manager của bạn.

Ví dụ:

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 } });

JavaScript (cũ)

// 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 } });

Xem thêm

• Nhắm mục tiêu khoá-giá trị

---

Optional threadYield

threadYield?: "DISABLED" | "ENABLED_ALL_SLOTS"

Chế độ cài đặt để kiểm soát việc GPT có nên tạo luồng JS khi yêu cầu và hiển thị mẫu quảng cáo hay không.

GPT sẽ chỉ tạo cho những trình duyệt hỗ trợ API Scheduler.postTask hoặc Scheduler.yield.

Các giá trị được hỗ trợ:

• null (mặc định): GPT sẽ tạo luồng JS cho các vị trí bên ngoài khung hiển thị.
• ENABLED_ALL_SLOTS: GPT sẽ tạo luồng JS cho tất cả các vị trí, bất kể vị trí đó có nằm trong khung hiển thị hay không.
• DISABLED: GPT sẽ không tạo ra luồng JS.

Ví dụ:

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 });

JavaScript (cũ)

// 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 });

Xem thêm

• Trình lập lịch

---

Optional videoAds

videoAds?: VideoAdsConfig

Các chế độ cài đặt để kiểm soát quảng cáo dạng video.

Ví dụ:

JavaScript

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

JavaScript (cũ)

// 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",
  },
});

Xem thêm

• Nhập nội dung video

---

googletag.config.PrivacyTreatmentsConfig

Các chế độ cài đặt để kiểm soát cách xử lý quyền riêng tư của nhà xuất bản.

Thuộc tính
treatments	Một mảng các cách xử lý quyền riêng tư của nhà xuất bản cần bật.

Thuộc tính

---

phương pháp điều trị

treatments: "disablePersonalization"[]

Một mảng gồm các cách nhà xuất bản xử lý quyền riêng tư cần bật.

Ví dụ:

JavaScript

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

JavaScript (cũ)

// 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

Đối tượng cấu hình tín hiệu do nhà xuất bản cung cấp (PPS).

Thuộc tính
taxonomies	Một đối tượng chứa các lượt ánh xạ Phân loại hoặc giá trị rỗng để xoá cấu hình.

Ví dụ:

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'
    },
  },
});

JavaScript (cũ)

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'
    },
  },
});

Xem thêm

• Giới thiệu về tín hiệu do nhà xuất bản cung cấp (Thử nghiệm)
• Hệ thống phân loại đối tượng theo IAB 1.1
• Hệ thống phân loại nội dung 2.2 của IAB

Thuộc tính

---

phân loại

taxonomies: Partial<Record<Taxonomy, TaxonomyData>>

Một đối tượng chứa các lượt ánh xạ Phân loại hoặc giá trị rỗng để xoá cấu hình.

---

googletag.config.SafeFrameConfig

Các chế độ cài đặt để kiểm soát SafeFrame trong GPT.

Thuộc tính
allowOverlayExpansion?	Liệu SafeFrame có cho phép nội dung quảng cáo mở rộng bằng cách lớp phủ nội dung trang hay không.
allowPushExpansion?	Liệu SafeFrame có nên cho phép nội dung quảng cáo mở rộng bằng cách đẩy nội dung trang hay không.
forceSafeFrame?	Có nên buộc(các) quảng cáo hiển thị bằng vùng chứa SafeFrame hay không.
sandbox?	SafeFrame có nên sử dụng thuộc tính sandbox HTML5 để ngăn hoạt động điều hướng cấp cao nhất mà không có sự tương tác của người dùng hay không.
useUniqueDomain?	Không dùng nữa. SafeFrame có nên sử dụng các miền phụ ngẫu nhiên cho mẫu quảng cáo đặt trước hay không.

Xem thêm

• PageSettingsConfig.safeFrame
• SlotSettingsConfig.safeFrame

Thuộc tính

---

Optional allowOverlayExpansion

allowOverlayExpansion?: boolean

Liệu SafeFrame có cho phép nội dung quảng cáo mở rộng bằng cách lớp phủ nội dung trang hay không.

---

Optional allowPushExpansion

allowPushExpansion?: boolean

Liệu SafeFrame có nên cho phép nội dung quảng cáo mở rộng bằng cách đẩy nội dung trang hay không.

---

Optional forceSafeFrame

forceSafeFrame?: boolean

Có nên buộc(các) quảng cáo hiển thị bằng vùng chứa SafeFrame hay không.

---

Optional hộp cát

sandbox?: boolean

SafeFrame có nên sử dụng thuộc tính sandbox HTML5 để ngăn hoạt động điều hướng cấp cao nhất mà không có sự tương tác của người dùng hay không. Giá trị hợp lệ duy nhất là true (không thể buộc thành false). Xin lưu ý rằng thuộc tính hộp cát sẽ vô hiệu hoá các trình bổ trợ (ví dụ: Flash).

---

Optional useUniqueDomain

useUniqueDomain?: boolean

SafeFrame có nên sử dụng các miền phụ ngẫu nhiên cho mẫu quảng cáo đặt trước hay không. Truyền null để xoá giá trị đã lưu trữ.

Lưu ý: tính năng này được bật theo mặc định.

Không dùng nữa: Bạn không thể tắt tính năng này nữa. Việc đặt useUniqueDomain không có hiệu lực.

Xem thêm

• Hiển thị mẫu quảng cáo bằng SafeFrame

---

googletag.config.SlotSettingsConfig

Giao diện cấu hình chính cho các chế độ cài đặt ở cấp độ vị trí.

Cho phép thiết lập nhiều tính năng bằng một lệnh gọi API duy nhất cho một vị trí duy nhất.

Tất cả các thuộc tính được liệt kê bên dưới đều là ví dụ và không phản ánh các tính năng thực tế sử dụng setConfig. Để biết tập hợp các tính năng, hãy xem các trường trong loại SlotSettingsConfig bên dưới.

Ví dụ:

• Chỉ những tính năng được chỉ định trong lệnh gọi Slot.setConfig mới được sửa đổi.

    const slot = googletag.defineSlot("/1234567/example", [160, 600]);
  
    // Configure feature alpha.
    slot.setConfig({
        alpha: {...}
    });
  
    // Configure feature bravo. Feature alpha is unchanged.
    slot.setConfig({
       bravo: {...}
    });

• Tất cả chế độ cài đặt cho một tính năng nhất định sẽ được cập nhật theo mỗi lệnh gọi đến 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
        }
    });

• Bạn có thể xoá tất cả chế độ cài đặt cho một tính năng bằng cách truyền 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,
    });

Thuộc tính
adExpansion?	Chế độ cài đặt để định cấu hình tính năng mở rộng quảng cáo.
adsenseAttributes?	Chế độ cài đặt để định cấu hình các thuộc tính AdSense.
categoryExclusion?	Chế độ cài đặt để định cấu hình tiêu chí loại trừ danh mục quảng cáo.
clickUrl?	Chế độ cài đặt để định cấu hình URL mà người dùng sẽ được chuyển hướng đến sau khi nhấp vào quảng cáo.
collapseDiv?	Chế độ cài đặt để định cấu hình hành vi thu gọn của vị trí quảng cáo.
componentAuction?	Một mảng các phiên đấu giá thành phần sẽ được đưa vào phiên đấu giá quảng cáo trên thiết bị.
interstitial?	Các chế độ cài đặt định cấu hình hành vi của vị trí quảng cáo xen kẽ.
safeFrame?	Các chế độ cài đặt để định cấu hình việc sử dụng SafeFrame trong GPT.
targeting?	Chế độ cài đặt để định cấu hình tiêu chí nhắm mục tiêu khoá-giá trị.

Thuộc tính

---

Optional adExpansion

adExpansion?: AdExpansionConfig

Chế độ cài đặt để định cấu hình tính năng mở rộng quảng cáo.

Xem thêm

• Mở rộng quảng cáo

---

Optional adsenseAttributes

adsenseAttributes?: AdSenseAttributesConfig

Chế độ cài đặt để định cấu hình các thuộc tính AdSense.

Các thuộc tính AdSense được định cấu hình thông qua chế độ cài đặt này sẽ chỉ áp dụng cho vị trí quảng cáo. Bạn có thể gọi chế độ cài đặt này nhiều lần để xác định nhiều giá trị thuộc tính hoặc ghi đè các giá trị hiện có.

Các thay đổi về thuộc tính AdSense chỉ áp dụng cho những quảng cáo được yêu cầu sau khi phương thức này được gọi. Vì lý do đó, bạn nên gọi phương thức này trước khi gọi googletag.display hoặc PubAdsService.refresh.

Ví dụ:

JavaScript

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 (cũ)

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[]

Chế độ cài đặt để định cấu hình quy tắc loại trừ danh mục quảng cáo.

Ví dụ:

JavaScript

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 (cũ)

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 });

Xem thêm

• Nhãn tuỳ chỉnh để chặn quảng cáo

---

Optional clickUrl

clickUrl?: string

Chế độ cài đặt để định cấu hình URL mà người dùng sẽ được chuyển hướng đến sau khi nhấp vào quảng cáo.

Các máy chủ Google Ad Manager vẫn ghi lại lượt nhấp ngay cả khi URL nhấp chuột được thay thế. Mọi URL trang đích được liên kết với mẫu quảng cáo được phân phát đều được thêm vào giá trị được cung cấp. Việc đặt giá trị này nhiều lần sẽ ghi đè mọi giá trị đã được định cấu hình trước đó. Truyền null sẽ xoá giá trị.

Lưu ý: Chế độ cài đặt này chỉ áp dụng cho các yêu cầu không phải SRA.

Ví dụ:

JavaScript

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 (cũ)

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

Chế độ cài đặt để định cấu hình hành vi thu gọn của vùng quảng cáo.

Vùng quảng cáo thu gọn sẽ không chiếm bất kỳ khoảng trống nào trên trang.

Các giá trị được hỗ trợ:

• null (mặc định): Vị trí sẽ không bị thu gọn.
• DISABLED: Vùng quảng cáo sẽ không thu gọn, bất kể quảng cáo có được trả về hay không.
• BEFORE_FETCH: Vùng quảng cáo sẽ bắt đầu ở trạng thái thu gọn và mở rộng khi quảng cáo được trả về.
• ON_NO_FILL: Vùng quảng cáo sẽ bắt đầu ở trạng thái mở rộng và thu gọn nếu không có quảng cáo nào được trả về.

Ví dụ:

JavaScript

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 (cũ)

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,
});

Xem thêm

• Thu gọn vùng quảng cáo trống
• Giảm thiểu mức thay đổi bố cục

---

Optional componentAuction

componentAuction?: ComponentAuctionConfig[]

Một mảng các phiên đấu giá thành phần sẽ được đưa vào phiên đấu giá quảng cáo trên thiết bị.

---

Optional quảng cáo xen kẽ

interstitial?: InterstitialConfig

Các chế độ cài đặt định cấu hình hành vi của vị trí quảng cáo xen kẽ.

Xem thêm

• Quảng cáo xen kẽ trên web để tăng lưu lượng truy cập

---

Optional safeFrame

safeFrame?: SafeFrameConfig

Chế độ cài đặt để định cấu hình việc sử dụng SafeFrame trong GPT.

Các giá trị được định cấu hình thông qua chế độ cài đặt này sẽ chỉ áp dụng cho vùng quảng cáo và ghi đè các giá trị được đặt thông qua PageSettingsConfig.safeFrame.

Ví dụ:

JavaScript

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 (cũ)

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 nhắm mục tiêu

targeting?: Record<string, string | string[]>

Chế độ cài đặt để định cấu hình tiêu chí nhắm mục tiêu theo khoá-giá trị.

Tiêu chí nhắm mục tiêu được định cấu hình thông qua chế độ cài đặt này sẽ chỉ áp dụng cho vùng quảng cáo. Bạn có thể gọi chế độ cài đặt này nhiều lần để xác định nhiều khoá-giá trị nhắm mục tiêu hoặc ghi đè các giá trị hiện có. Khoá nhắm mục tiêu được xác định trong tài khoản Google Ad Manager của bạn.

Ví dụ:

JavaScript

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 (cũ)

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 });

Xem thêm

• Nhắm mục tiêu khoá-giá trị

---

googletag.config.TaxonomyData

Một đối tượng chứa các giá trị cho một Phân loại duy nhất.

Thuộc tính
values	Danh sách các giá trị Phân loại.

Thuộc tính

---

giá trị

values: readonly string[]

Danh sách các giá trị Phân loại.

---

googletag.config.VideoAdsConfig

Chế độ cài đặt để định cấu hình các chế độ cài đặt liên quan đến quảng cáo dạng video.

Thuộc tính
enableVideoAds	Liệu quảng cáo dạng video có xuất hiện trên trang hay không.
videoCmsId?	Mã nguồn nội dung video.
videoContentId?	Mã nội dung video.

Xem thêm

• PageSettingsConfig.videoAds

Thuộc tính

---

enableVideoAds

enableVideoAds: boolean

Quảng cáo dạng video có xuất hiện trên trang hay không.

Khi được đặt thành true, chế độ này sẽ bật các điều kiện hạn chế loại trừ nội dung đối với quảng cáo hiển thị và quảng cáo dạng video.

Nếu nội dung video đã biết, hãy đặt videoContentId và videoCmsId thành các giá trị được cung cấp cho dịch vụ nhập nội dung của Google Ad Manager để sử dụng tính năng loại trừ nội dung cho quảng cáo hiển thị.

---

Optional videoCmsId

videoCmsId?: string

Mã nguồn nội dung video.

Đây là một giá trị duy nhất do dịch vụ nhập nội dung của Google Ad Manager chỉ định để xác định nguồn nội dung video do videoContentId chỉ định.

Xem thêm

• cmsid (Mã nguồn nội dung)

---

Optional videoContentId

videoContentId?: string

Mã nội dung video.

Đây là một giá trị duy nhất dùng để xác định một video cụ thể trong nguồn nội dung do videoCmsId chỉ định. Giá trị này do CMS lưu trữ nội dung video của bạn chỉ định.

Xem thêm

• vid (Mã video)

---

googletag.enums

Đây là không gian tên mà GPT sử dụng cho các loại enum.

Bảng liệt kê
OutOfPageFormat	Các định dạng ngoài trang được GPT hỗ trợ.
TrafficSource	Nguồn lưu lượng truy cập được GPT hỗ trợ.

Bảng liệt kê

---

OutOfPageFormat

OutOfPageFormat

Các định dạng ngoài trang mà GPT hỗ trợ.

Xem thêm

• defineOutOfPageSlot

Thành viên liệt kê
AD_INTENTS	Định dạng Quảng cáo dựa trên ý định.
BOTTOM_ANCHOR	Định dạng cố định, trong đó vị trí quảng cáo cố định ở cuối khung nhìn.
GAME_MANUAL_INTERSTITIAL	Định dạng quảng cáo xen kẽ thủ công trong trò chơi. Lưu ý: Quảng cáo xen kẽ thủ công trong trò chơi là một định dạng bị hạn chế quyền truy cập.
INTERSTITIAL	Định dạng mẫu quảng cáo xen kẽ trên web.
LEFT_SIDE_RAIL	Định dạng dải quảng cáo dọc cạnh trang bên trái.
REWARDED	Định dạng có tặng thưởng.
RIGHT_SIDE_RAIL	Định dạng dải quảng cáo dọc cạnh trang bên phải.
TOP_ANCHOR	Định dạng quảng cáo cố định, trong đó vị trí quảng cáo cố định ở đầu khung hiển thị.

---

TrafficSource

TrafficSource

Nguồn lưu lượng truy cập được GPT hỗ trợ.

Xem thêm

• PrivacySettingsConfig.trafficSource

Thành viên liệt kê
ORGANIC	Lượt nhập URL trực tiếp, lượt tìm kiếm trang web hoặc lượt tải ứng dụng xuống.
PURCHASED	Lưu lượng truy cập được chuyển hướng từ các tài sản không thuộc sở hữu (hoạt động có được hoặc được khuyến khích khác).

---

googletag.events

Đây là không gian tên mà GPT dùng cho Sự kiện. Mã của bạn có thể phản ứng với các sự kiện này bằng cách sử dụng Service.addEventListener.

Giao diện
Event	Giao diện cơ sở cho tất cả các sự kiện GPT.
EventTypeMap	Đây là một loại giả lập liên kết tên sự kiện với loại đối tượng sự kiện tương ứng cho Service.addEventListener và Service.removeEventListener.
GameManualInterstitialSlotClosedEvent	Sự kiện này được kích hoạt khi người dùng đóng một vị trí quảng cáo xen kẽ trong hướng dẫn về trò chơi.
GameManualInterstitialSlotReadyEvent	Sự kiện này được kích hoạt khi một vùng quảng cáo xen kẽ thủ công trong trò chơi đã sẵn sàng để hiển thị cho người dùng.
ImpressionViewableEvent	Sự kiện này được kích hoạt khi một lượt hiển thị trở thành lượt hiển thị có thể xem, theo tiêu chí của Chế độ xem đang kích hoạt.
RewardedSlotClosedEvent	Sự kiện này được kích hoạt khi người dùng đóng một vị trí quảng cáo có tặng thưởng.
RewardedSlotGrantedEvent	Sự kiện này được kích hoạt khi người dùng được thưởng vì xem một quảng cáo có tặng thưởng.
RewardedSlotReadyEvent	Sự kiện này được kích hoạt khi quảng cáo có tặng thưởng đã sẵn sàng hiển thị.
RewardedSlotVideoCompletedEvent	Sự kiện này được kích hoạt khi một quảng cáo dạng video có tặng thưởng phát xong.
SlotOnloadEvent	Sự kiện này được kích hoạt khi iframe của mẫu quảng cáo kích hoạt sự kiện tải.
SlotRenderEndedEvent	Sự kiện này được kích hoạt khi mã mẫu quảng cáo được chèn vào một vị trí.
SlotRequestedEvent	Sự kiện này được kích hoạt khi một quảng cáo được yêu cầu cho một vị trí cụ thể.
SlotResponseReceived	Sự kiện này được kích hoạt khi một phản hồi quảng cáo đã được nhận cho một vị trí cụ thể.
SlotVisibilityChangedEvent	Sự kiện này sẽ kích hoạt bất cứ khi nào tỷ lệ phần trăm diện tích của một vị trí quảng cáo thay đổi trên màn hình.

---

googletag.events.Event

Giao diện cơ sở cho tất cả các sự kiện GPT. Tất cả các sự kiện GPT bên dưới sẽ có các trường sau.

Thuộc tính
serviceName	Tên của dịch vụ đã kích hoạt sự kiện.
slot	Vị trí đã kích hoạt sự kiện.

Xem thêm

• Trình nghe sự kiện quảng cáo

Thuộc tính

---

serviceName

serviceName: string

Tên của dịch vụ đã kích hoạt sự kiện.

---

slot

slot: Slot

Vị trí đã kích hoạt sự kiện.

---

googletag.events.EventTypeMap

Đây là một loại giả lập liên kết tên sự kiện với loại đối tượng sự kiện tương ứng cho Service.addEventListener và Service.removeEventListener. Thông tin này chỉ được ghi lại cho mục đích tham khảo và đảm bảo an toàn về kiểu dữ liệu.

Thuộc tính
gameManualInterstitialSlotClosed	Tên thay thế cho events.GameManualInterstitialSlotClosedEvent.
gameManualInterstitialSlotReady	Tên thay thế cho events.GameManualInterstitialSlotReadyEvent.
impressionViewable	Tên thay thế cho events.ImpressionViewableEvent.
rewardedSlotClosed	Tên thay thế cho events.RewardedSlotClosedEvent.
rewardedSlotGranted	Bí danh cho events.RewardedSlotGrantedEvent.
rewardedSlotReady	Bí danh cho events.RewardedSlotReadyEvent.
rewardedSlotVideoCompleted	Bí danh cho events.RewardedSlotVideoCompletedEvent.
slotOnload	Bí danh cho events.SlotOnloadEvent.
slotRenderEnded	Tên thay thế cho events.SlotRenderEndedEvent.
slotRequested	Bí danh cho events.SlotRequestedEvent.
slotResponseReceived	Bí danh cho events.SlotResponseReceived.
slotVisibilityChanged	Tên thay thế cho events.SlotVisibilityChangedEvent.

Thuộc tính

---

gameManualInterstitialSlotClosed

gameManualInterstitialSlotClosed: GameManualInterstitialSlotClosedEvent

Tên thay thế cho events.GameManualInterstitialSlotClosedEvent.

---

gameManualInterstitialSlotReady

gameManualInterstitialSlotReady: GameManualInterstitialSlotReadyEvent

Tên thay thế cho events.GameManualInterstitialSlotReadyEvent.

---

impressionViewable

impressionViewable: ImpressionViewableEvent

Tên thay thế cho events.ImpressionViewableEvent.

---

rewardedSlotClosed

rewardedSlotClosed: RewardedSlotClosedEvent

Tên thay thế cho events.RewardedSlotClosedEvent.

---

rewardedSlotGranted

rewardedSlotGranted: RewardedSlotGrantedEvent

Bí danh cho events.RewardedSlotGrantedEvent.

---

rewardedSlotReady

rewardedSlotReady: RewardedSlotReadyEvent

Bí danh cho events.RewardedSlotReadyEvent.

---

rewardedSlotVideoCompleted

rewardedSlotVideoCompleted: RewardedSlotVideoCompletedEvent

Bí danh cho events.RewardedSlotVideoCompletedEvent.

---

slotOnload

slotOnload: SlotOnloadEvent

Bí danh cho events.SlotOnloadEvent.

---

slotRenderEnded

slotRenderEnded: SlotRenderEndedEvent

Tên thay thế cho events.SlotRenderEndedEvent.

---

slotRequested

slotRequested: SlotRequestedEvent

Bí danh cho events.SlotRequestedEvent.

---

slotResponseReceived

slotResponseReceived: SlotResponseReceived

Bí danh cho events.SlotResponseReceived.

---

slotVisibilityChanged

slotVisibilityChanged: SlotVisibilityChangedEvent

Tên thay thế cho events.SlotVisibilityChangedEvent.

---

googletag.events.GameManualInterstitialSlotClosedEvent

Mở rộng Event

Sự kiện này được kích hoạt khi người dùng đóng một vùng quảng cáo xen kẽ thủ công trong trò chơi.

Lưu ý: Quảng cáo xen kẽ thủ công trong trò chơi là một định dạng bị hạn chế quyền truy cập.

Thuộc tính
serviceName	Tên của dịch vụ đã kích hoạt sự kiện. Kế thừa từ Event.serviceName
slot	Vị trí đã kích hoạt sự kiện. Kế thừa từ Event.slot

Ví dụ:

JavaScript

// 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 (cũ)

// 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.
    }
  });
}

Xem thêm

• Trình nghe sự kiện quảng cáo
• Hiển thị quảng cáo xen kẽ thủ công trong trò chơi

---

googletag.events.GameManualInterstitialSlotReadyEvent

Mở rộng Event

Sự kiện này được kích hoạt khi một vùng quảng cáo xen kẽ thủ công trong trò chơi đã sẵn sàng để hiển thị cho người dùng.

Lưu ý: Quảng cáo xen kẽ thủ công trong trò chơi là một định dạng bị hạn chế quyền truy cập.

Thuộc tính
serviceName	Tên của dịch vụ đã kích hoạt sự kiện. Kế thừa từ Event.serviceName
slot	Vị trí đã kích hoạt sự kiện. Kế thừa từ Event.slot

Phương thức
makeGameManualInterstitialVisible	Hiển thị quảng cáo xen kẽ thủ công trong trò chơi cho người dùng.

Ví dụ:

JavaScript

// 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 (cũ)

// 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.
    }
  });
}

Xem thêm

• Trình nghe sự kiện quảng cáo
• Hiển thị quảng cáo xen kẽ thủ công trong trò chơi

Phương thức

---

makeGameManualInterstitialVisible

makeGameManualInterstitialVisible(): void

Hiển thị quảng cáo xen kẽ thủ công trong trò chơi cho người dùng.

---

googletag.events.ImpressionViewableEvent

Mở rộng Event

Sự kiện này được kích hoạt khi một lượt hiển thị trở thành lượt hiển thị có thể xem, theo tiêu chí của Chế độ xem đang kích hoạt.

Thuộc tính
serviceName	Tên của dịch vụ đã kích hoạt sự kiện. Kế thừa từ Event.serviceName
slot	Vị trí đã kích hoạt sự kiện. Kế thừa từ Event.slot

Ví dụ:

JavaScript

// 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 (cũ)

// 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.
  }
});

Xem thêm

• Trình nghe sự kiện quảng cáo

---

googletag.events.RewardedSlotClosedEvent

Mở rộng Event

Sự kiện này được kích hoạt khi người dùng đóng một vị trí quảng cáo có tặng thưởng. Sự kiện này có thể kích hoạt trước hoặc sau khi phần thưởng được trao. Để xác định xem phần thưởng đã được trao hay chưa, hãy dùng events.RewardedSlotGrantedEvent.

Thuộc tính
serviceName	Tên của dịch vụ đã kích hoạt sự kiện. Kế thừa từ Event.serviceName
slot	Vị trí đã kích hoạt sự kiện. Kế thừa từ Event.slot

Ví dụ:

JavaScript

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 (cũ)

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.
    }
  });
}

Xem thêm

• Trình nghe sự kiện quảng cáo
• Hiển thị quảng cáo có tặng thưởng

---

googletag.events.RewardedSlotGrantedEvent

Mở rộng Event

Sự kiện này được kích hoạt khi người dùng được thưởng vì xem một quảng cáo có tặng thưởng. Nếu quảng cáo bị đóng trước khi đáp ứng các tiêu chí để cấp phần thưởng, thì sự kiện này sẽ không kích hoạt.

Thuộc tính
payload	Một đối tượng chứa thông tin về phần thưởng đã được trao.
serviceName	Tên của dịch vụ đã kích hoạt sự kiện. Kế thừa từ Event.serviceName
slot	Vị trí đã kích hoạt sự kiện. Kế thừa từ Event.slot

Ví dụ:

JavaScript

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 (cũ)

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.
    }
  });
}

Xem thêm

• Trình nghe sự kiện quảng cáo
• Hiển thị quảng cáo có tặng thưởng

Thuộc tính

---

tải trọng

payload: RewardedPayload

Một đối tượng chứa thông tin về phần thưởng đã được trao.

---

googletag.events.RewardedSlotReadyEvent

Mở rộng Event

Sự kiện này được kích hoạt khi quảng cáo có tặng thưởng đã sẵn sàng hiển thị. Nhà xuất bản chịu trách nhiệm cung cấp cho người dùng lựa chọn xem quảng cáo trước khi hiển thị quảng cáo.

Thuộc tính
serviceName	Tên của dịch vụ đã kích hoạt sự kiện. Kế thừa từ Event.serviceName
slot	Vị trí đã kích hoạt sự kiện. Kế thừa từ Event.slot

Phương thức
makeRewardedVisible	Hiển thị quảng cáo có tặng thưởng.

Ví dụ:

JavaScript

// 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 (cũ)

// 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.
    }
  });
}

Xem thêm

• Trình nghe sự kiện quảng cáo
• Hiển thị quảng cáo có tặng thưởng

Phương thức

---

makeRewardedVisible

makeRewardedVisible(): void

Hiển thị quảng cáo có tặng thưởng. Bạn không nên gọi phương thức này cho đến khi người dùng đồng ý xem quảng cáo.

---

googletag.events.RewardedSlotVideoCompletedEvent

Mở rộng Event

Sự kiện này được kích hoạt khi một quảng cáo dạng video có tặng thưởng phát xong.

Thuộc tính
serviceName	Tên của dịch vụ đã kích hoạt sự kiện. Kế thừa từ Event.serviceName
slot	Vị trí đã kích hoạt sự kiện. Kế thừa từ Event.slot

Ví dụ:

JavaScript

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 (cũ)

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.
    }
  });
}

Xem thêm

• Trình nghe sự kiện quảng cáo
• Hiển thị quảng cáo có tặng thưởng

---

googletag.events.SlotOnloadEvent

Mở rộng Event

Sự kiện này được kích hoạt khi iframe của mẫu quảng cáo kích hoạt sự kiện tải. Khi hiển thị quảng cáo đa phương tiện ở chế độ hiển thị đồng bộ, không có iframe nào được dùng nên sẽ không có SlotOnloadEvent nào được kích hoạt.

Thuộc tính
serviceName	Tên của dịch vụ đã kích hoạt sự kiện. Kế thừa từ Event.serviceName
slot	Vị trí đã kích hoạt sự kiện. Kế thừa từ Event.slot

Ví dụ:

JavaScript

// 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 (cũ)

// 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.
  }
});

Xem thêm

• Trình nghe sự kiện quảng cáo

---

googletag.events.SlotRenderEndedEvent

Mở rộng Event

Sự kiện này được kích hoạt khi mã mẫu quảng cáo được chèn vào một vị trí. Sự kiện này sẽ xảy ra trước khi các tài nguyên của mẫu quảng cáo được tìm nạp, vì vậy, mẫu quảng cáo có thể chưa xuất hiện. Nếu bạn cần biết thời điểm tất cả tài nguyên mẫu quảng cáo cho một vùng đã tải xong, hãy cân nhắc sử dụng events.SlotOnloadEvent.

Thuộc tính
advertiserId	Mã nhận dạng nhà quảng cáo của quảng cáo được hiển thị.
campaignId	Mã chiến dịch của quảng cáo được hiển thị.
companyIds	Mã nhận dạng của những công ty đặt giá thầu cho quảng cáo thay thế được hiển thị.
creativeId	Mã mẫu quảng cáo của quảng cáo đặt phòng được hiển thị.
creativeTemplateId	Mã mẫu quảng cáo của quảng cáo đặt trước được hiển thị.
isBackfill	Quảng cáo có phải là quảng cáo chèn lấp hay không.
isEmpty	Quảng cáo có được trả về cho vị trí hay không.
labelIds	Không dùng nữa.
lineItemId	Mã mục hàng của quảng cáo đặt trước được hiển thị.
responseIdentifier	Giá trị nhận dạng nội dung phản hồi là giá trị nhận dạng duy nhất của nội dung phản hồi quảng cáo.
serviceName	Tên của dịch vụ đã kích hoạt sự kiện. Kế thừa từ Event.serviceName
size	Cho biết kích thước tính bằng pixel của mẫu quảng cáo được hiển thị.
slot	Vị trí đã kích hoạt sự kiện. Kế thừa từ Event.slot
slotContentChanged	Nội dung của vùng quảng cáo có thay đổi khi quảng cáo được hiển thị hay không.
sourceAgnosticCreativeId	Mã mẫu quảng cáo của quảng cáo thay thế hoặc quảng cáo đặt trước được hiển thị.
sourceAgnosticLineItemId	Mã mục hàng của quảng cáo thay thế hoặc quảng cáo đặt trước được hiển thị.
yieldGroupIds	Mã nhận dạng của các nhóm lợi nhuận cho quảng cáo thay thế được hiển thị.

Ví dụ:

JavaScript

// 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 (cũ)

// 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.
  }
});

Xem thêm

• Trình nghe sự kiện quảng cáo

Thuộc tính

---

advertiserId

advertiserId: number

Mã nhận dạng nhà quảng cáo của quảng cáo được hiển thị. Giá trị là null đối với các vùng quảng cáo trống, quảng cáo thay thế và mẫu quảng cáo do các dịch vụ khác ngoài PubAdsService hiển thị.

---

campaignId

campaignId: number

Mã chiến dịch của quảng cáo được hiển thị. Giá trị là null đối với các vùng quảng cáo trống, quảng cáo thay thế và mẫu quảng cáo do các dịch vụ khác ngoài PubAdsService hiển thị.

---

companyIds

companyIds: number[]

Mã nhận dạng của những công ty đặt giá thầu cho quảng cáo thay thế được hiển thị. Giá trị là null đối với các vị trí trống, quảng cáo đặt trước và mẫu quảng cáo do các dịch vụ khác ngoài PubAdsService hiển thị.

---

creativeId

creativeId: number

Mã mẫu quảng cáo của quảng cáo đặt phòng được hiển thị. Giá trị là null đối với các vùng quảng cáo trống, quảng cáo thay thế và mẫu quảng cáo do các dịch vụ khác ngoài PubAdsService hiển thị.

---

creativeTemplateId

creativeTemplateId: number

Mã mẫu quảng cáo của quảng cáo đặt trước được hiển thị. Giá trị là null đối với các vùng quảng cáo trống, quảng cáo thay thế và mẫu quảng cáo do các dịch vụ khác ngoài PubAdsService hiển thị.

---

isBackfill

isBackfill: boolean

Quảng cáo có phải là quảng cáo chèn lấp hay không. Giá trị là true nếu quảng cáo là quảng cáo thay thế, false nếu không.

---

isEmpty

isEmpty: boolean

Quảng cáo có được trả về cho vị trí hay không. Giá trị là true nếu không có quảng cáo nào được trả về, nếu không thì giá trị là false.

---

labelIds

labelIds: number[]

Không dùng nữa: Trường này không còn được điền sẵn nữa.

---

lineItemId

lineItemId: number

Mã mục hàng của quảng cáo đặt trước được hiển thị. Giá trị là null đối với các vùng quảng cáo trống, quảng cáo thay thế và mẫu quảng cáo do các dịch vụ khác ngoài PubAdsService hiển thị.

---

responseIdentifier

responseIdentifier: string

Giá trị nhận dạng nội dung phản hồi là giá trị nhận dạng duy nhất của nội dung phản hồi quảng cáo. Bạn có thể sử dụng giá trị này để xác định và chặn quảng cáo trong Trung tâm xem xét quảng cáo (ARC).

---

size

size: string | number[]

Cho biết kích thước tính bằng pixel của mẫu quảng cáo được hiển thị. Ví dụ: [728, 90] Giá trị là null đối với các vùng quảng cáo trống.

---

slotContentChanged

slotContentChanged: boolean

Nội dung của vùng quảng cáo có thay đổi khi quảng cáo được hiển thị hay không. Nếu nội dung đã thay đổi thì giá trị sẽ là true, nếu không thì giá trị sẽ là false.

---

sourceAgnosticCreativeId

sourceAgnosticCreativeId: number

Mã mẫu quảng cáo của quảng cáo thay thế hoặc quảng cáo đặt trước được hiển thị. Giá trị là null nếu quảng cáo không phải là quảng cáo đặt trước hoặc quảng cáo thay thế mục hàng, hoặc mẫu quảng cáo được hiển thị bởi các dịch vụ khác ngoài PubAdsService.

---

sourceAgnosticLineItemId

sourceAgnosticLineItemId: number

Mã mục hàng của quảng cáo thay thế hoặc quảng cáo đặt trước được hiển thị. Giá trị là null nếu quảng cáo không phải là quảng cáo đặt trước hoặc quảng cáo thay thế mục hàng, hoặc mẫu quảng cáo được hiển thị bởi các dịch vụ khác ngoài PubAdsService.

---

yieldGroupIds

yieldGroupIds: number[]

Mã nhận dạng của các nhóm lợi nhuận cho quảng cáo thay thế được hiển thị. Giá trị là null đối với các vị trí trống, quảng cáo đặt trước và mẫu quảng cáo do các dịch vụ khác ngoài PubAdsService hiển thị.

---

googletag.events.SlotRequestedEvent

Mở rộng Event

Sự kiện này được kích hoạt khi một quảng cáo được yêu cầu cho một vị trí cụ thể.

Thuộc tính
serviceName	Tên của dịch vụ đã kích hoạt sự kiện. Kế thừa từ Event.serviceName
slot	Vị trí đã kích hoạt sự kiện. Kế thừa từ Event.slot

Ví dụ:

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.
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 (cũ)

// 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.
  }
});

Xem thêm

• Trình nghe sự kiện quảng cáo

---

googletag.events.SlotResponseReceived

Mở rộng Event

Sự kiện này được kích hoạt khi một phản hồi quảng cáo đã được nhận cho một vị trí cụ thể.

Thuộc tính
serviceName	Tên của dịch vụ đã kích hoạt sự kiện. Kế thừa từ Event.serviceName
slot	Vị trí đã kích hoạt sự kiện. Kế thừa từ Event.slot

Ví dụ:

JavaScript

// 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 (cũ)

// 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.
  }
});

Xem thêm

• Trình nghe sự kiện quảng cáo

---

googletag.events.SlotVisibilityChangedEvent

Mở rộng Event

Sự kiện này sẽ kích hoạt bất cứ khi nào tỷ lệ phần trăm diện tích của một vị trí quảng cáo thay đổi trên màn hình. Sự kiện này bị điều tiết và sẽ không kích hoạt thường xuyên hơn 1 lần sau mỗi 200 mili giây.

Thuộc tính
inViewPercentage	Tỷ lệ phần trăm diện tích quảng cáo hiển thị.
serviceName	Tên của dịch vụ đã kích hoạt sự kiện. Kế thừa từ Event.serviceName
slot	Vị trí đã kích hoạt sự kiện. Kế thừa từ Event.slot

Ví dụ:

JavaScript

// 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 (cũ)

// 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.
  }
});

Xem thêm

• Trình nghe sự kiện quảng cáo

Thuộc tính

---

inViewPercentage

inViewPercentage: number

Tỷ lệ phần trăm diện tích quảng cáo hiển thị. Giá trị là một số từ 0 đến 100.

---

googletag.secureSignals

Đây là không gian tên mà GPT dùng để quản lý tín hiệu an toàn.

Giao diện
BidderSignalProvider	Trả về một tín hiệu an toàn cho một bên đặt giá thầu cụ thể.
PublisherSignalProvider	Trả về một tín hiệu an toàn cho một nhà xuất bản cụ thể.
SecureSignalProvidersArray	Một giao diện để quản lý tín hiệu an toàn.

Bí danh loại
SecureSignalProvider	Giao diện để trả về một tín hiệu an toàn cho một bên đặt giá thầu hoặc nhà cung cấp cụ thể.

Bí danh loại

---

SecureSignalProvider

SecureSignalProvider: BidderSignalProvider | PublisherSignalProvider

Giao diện để trả về một tín hiệu an toàn cho một bên đặt giá thầu hoặc nhà cung cấp cụ thể. Bạn phải cung cấp một trong hai thuộc tính id hoặc networkCode, nhưng không được cung cấp cả hai.

---

googletag.secureSignals.BidderSignalProvider

Trả về một tín hiệu an toàn cho một bên đặt giá thầu cụ thể.

Nhà cung cấp tín hiệu an toàn của bên đặt giá thầu bao gồm 2 phần:

1. Một hàm thu thập, trả về một Promise phân giải thành một tín hiệu an toàn.
2. Một id xác định bên đặt giá thầu được liên kết với tín hiệu.

Để trả về tín hiệu an toàn cho nhà xuất bản, hãy sử dụng secureSignals.PublisherSignalProvider.

Thuộc tính
collectorFunction	Một hàm trả về Promise phân giải thành một tín hiệu an toàn.
id	Giá trị nhận dạng riêng biệt của trình thu thập được liên kết với tín hiệu an toàn này, như đã đăng ký trong Google Ad Manager.

Ví dụ:

JavaScript

// id is provided
googletag.secureSignalProviders.push({
  id: "collector123",
  collectorFunction: () => {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});

JavaScript (cũ)

// 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");
  },
});

Xem thêm

• Chia sẻ tín hiệu an toàn với bên đặt giá thầu

Thuộc tính

---

collectorFunction

collectorFunction: (() => Promise<string>)

Một hàm trả về Promise phân giải thành một tín hiệu an toàn.

---

id

id: string

Giá trị nhận dạng riêng biệt của trình thu thập được liên kết với tín hiệu an toàn này, như đã đăng ký trong Google Ad Manager.

---

googletag.secureSignals.PublisherSignalProvider

Trả về một tín hiệu an toàn cho một nhà xuất bản cụ thể.

Nhà cung cấp tín hiệu của nhà xuất bản bao gồm 2 phần:

1. Một hàm thu thập, trả về một Promise phân giải thành một tín hiệu an toàn.
2. Một networkCode xác định nhà xuất bản được liên kết với tín hiệu.

Để trả về một tín hiệu an toàn cho bên đặt giá thầu, hãy sử dụng secureSignals.BidderSignalProvider.

Thuộc tính
collectorFunction	Một hàm trả về Promise phân giải thành một tín hiệu an toàn.
networkCode	Mã mạng (như trong đường dẫn đơn vị quảng cáo) của nhà xuất bản được liên kết với tín hiệu an toàn này.

Ví dụ:

JavaScript

// networkCode is provided
googletag.secureSignalProviders.push({
  networkCode: "123456",
  collectorFunction: () => {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});

JavaScript (cũ)

// 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");
  },
});

Xem thêm

• Chia sẻ tín hiệu an toàn với bên đặt giá thầu

Thuộc tính

---

collectorFunction

collectorFunction: (() => Promise<string>)

Một hàm trả về Promise phân giải thành một tín hiệu an toàn.

---

networkCode

networkCode: string

Mã mạng (như trong đường dẫn đơn vị quảng cáo) của nhà xuất bản được liên kết với tín hiệu an toàn này.

---

googletag.secureSignals.SecureSignalProvidersArray

Một giao diện để quản lý tín hiệu an toàn.

Phương thức
clearAllCache	Xoá tất cả tín hiệu cho mọi bộ sưu tập khỏi bộ nhớ đệm.
push	Thêm một secureSignals.SecureSignalProvider mới vào mảng nhà cung cấp tín hiệu và bắt đầu quy trình tạo tín hiệu.

Phương thức

---

clearAllCache

clearAllCache(): void

Xoá tất cả tín hiệu cho tất cả các trình thu thập khỏi bộ nhớ đệm.

Việc gọi phương thức này có thể làm giảm khả năng đưa tín hiệu vào yêu cầu quảng cáo cho lượt xem trang hiện tại và có thể là lượt xem trang sau đó. Do đó, bạn chỉ nên gọi phương thức này khi có sự thay đổi trạng thái quan trọng, chẳng hạn như các sự kiện cho thấy có người dùng mới (đăng nhập, đăng xuất, đăng ký, v.v.).

---

push

push(provider: SecureSignalProvider): void

Thêm một secureSignals.SecureSignalProvider mới vào mảng nhà cung cấp tín hiệu và bắt đầu quy trình tạo tín hiệu.

Thông số
provider: SecureSignalProvider	Đối tượng secureSignals.SecureSignalProvider sẽ được thêm vào mảng.