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 lời giải thích ngắn gọn kèm theo ví dụ.

Biểu thức kiểu dữ liệu
string	Loại chuỗi gốc.
string[]	Một loại mảng, trong đó các giá trị chỉ có thể là chuỗi.
number | string	Kiểu hợp nhất, trong đó giá trị có thể là số hoặc chuỗi.
Array<number | string>	Kiểu mảng, trong đó các giá trị là kiểu phức tạp (kiểu hợp nhất).
[number, string]	Kiểu bộ dữ liệu, 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ố 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 tên biến, tên tham số, tên thuộc tính hoặc chữ ký hàm biểu thị một chú thích 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 dữ liệu
param: string	Cho biết 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 một số hoặc một chuỗi khi được chỉ định. Cú pháp này được dùng cho các tham số và thuộc tính.
...params: Array<() => void>	Cho biết 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 số lượng giá trị không giới hạn của loại được chỉ định.

---

googletag

Không gian tên chung mà Thẻ nhà xuất bản của Google sử 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 sử dụng cho Sự kiện.
secureSignals	Đây là không gian tên mà GPT sử 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 hàm và gọi các hàm đó 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.
RequestHook	Hàm callback được gọi trước mỗi yêu cầu quảng cáo khi được đăng ký qua PubAdsService.registerRequestHook.
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 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ả dịch vụ.
SizeMappingBuilder	Trình tạo cho các đối tượng thông số kỹ thuật ánh xạ kích thước.
Slot	Vị trí là một đối tượng đại diện cho một vị trí quảng cáo trên một trang.

Bí danh loại
FluidSize	Chuỗi kích thước trong đó vùng chứa quảng cáo chiếm 100% chiều rộng của div mẹ, sau đó đổi kích thước chiều cao cho phù hợp với nội dung mẫu quảng cáo.
GeneralSize	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ệ.
NamedSize	Kích thước được đặt tên mà một vị trí 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 hai số đại diện cho [chiều rộng, chiều cao].
SizeMapping	Ánh xạ kích thước khung nhìn với 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 GPT API đã được tải và sẵn sàng để 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ề thông tin tham chiếu đến CompanionAdsService.
defineOutOfPageSlot	Tạo một vị trí quảng cáo ngoài trang với đường dẫn đơn vị quảng cáo nhất định.
defineSlot	Tạo một vị trí 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ị trí 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 quảng cáo đã cho, xoá tất cả các đối tượng và tham chiếu có liên quan của các vùng quảng cáo đó 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ụ vùng quảng cáo hiển thị vùng quảng cáo.
enableServices	Bật tất cả các dịch vụ GPT đã được xác định cho vị trí quảng cáo trên trang.
getConfig	Lấy bản sao cố định của các tuỳ 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ề thông tin 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, 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

---

FluidSize

FluidSize: "fluid"

Chuỗi kích thước trong đó vùng chứa quảng cáo chiếm 100% chiều rộng của div mẹ, sau đó đổi kích thước chiều cao cho phù hợp với nội dung mẫu quảng cáo. Tương tự như cách hoạt động của các phần tử khối thông thường trên một trang. Được dùng cho quảng cáo gốc và quảng cáo biểu ngữ (xem bài viết liên quan).

---

GeneralSize

GeneralSize: SingleSize | MultiSize

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

---

NamedSize

NamedSize: FluidSize | [FluidSize]

Kích thước được đặt tên mà một vị trí 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 thông số kích thước khác. Chỉ những kích thước sau đây mới là kích thước được đặt tên hợp lệ:

• fluid: vùng chứa quảng cáo chiếm 100% chiều rộng của div mẹ, sau đó đổi kích thước chiều cao cho phù hợp với nội dung mẫu quảng cáo. Tương tự như cách hoạt động của các phần tử khối thông thường trên một trang. Được dùng cho quảng cáo gốc và quảng cáo biểu ngữ (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 hai số đại diện cho [chiều rộng, chiều cao].

---

SizeMapping

SizeMapping: [SingleSizeArray, GeneralSize]

Ánh xạ kích thước khung nhìn với kích thước quảng cáo. Được 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 GPT API đã được tải và sẵn sàng để 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 để đưa lệnh gọi lại vào hàng đợi khi GPT sẵn sàng. Các lệnh gọi lại này không cần phải kiểm tra googletag.apiReady vì chúng được đảm bảo 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.

Biến googletag.cmd được khởi tạo thành một mảng JavaScript trống theo cú pháp thẻ GPT trên trang và cmd.push là phương thức Array.push chuẩn để 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 đến đối tượng đó. Cơ chế này cho phép GPT giảm độ trễ nhận thấy bằng cách tìm nạp JavaScript không đồng bộ, đồng thời 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 các hàm đó theo thứ tự. Hàm này dùng để thay thế một mảng chuẩn được dùng để đưa các hàm tạo tín hiệu vào hàng đợi để gọi sau 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ề thông tin 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ị trí quảng cáo ngoài trang với đường dẫn đơn vị quảng cáo nhất định.

Đối với quảng cáo ngoài trang tuỳ chỉnh, 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 ngoài trang để biết thêm chi tiết.

Đối với quảng cáo 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 neo
• Hiển thị quảng cáo ngoài trang

Thông số
adUnitPath: string	Đường dẫn đơn vị quảng cáo đầy đủ có mã mạng và mã đơn vị quảng cáo.
Optional div: string | OutOfPageFormat	Mã 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 được tạo hoặc null nếu không thể tạo vị trí.

---

defineSlot

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

Tạo một vị trí 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ị trí 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 đơn vị quảng cáo đầy đủ có mã mạng và mã đơn vị.
size: GeneralSize	Chiều rộng và chiều cao của vị trí quảng cáo đã thêm. Đây là kích thước được sử dụng trong yêu cầu quảng cáo nếu không có mối liên kết kích thước thích ứng nào được cung cấp hoặc kích thước của khung nhìn nhỏ hơn kích thước nhỏ nhất được cung cấp trong mối liên kết.
Optional div: string	Mã của div sẽ chứa đơn vị quảng cáo này.

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

---

destroySlots

destroySlots(slots?: Slot[]): boolean

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

Việc gọi API này trên một vùng quảng cáo sẽ xoá quảng cáo và xoá đối tượng vùng quảng cáo 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 vùng quảng cáo sẽ dẫn đến hành vi không xác định. Xin lưu ý rằng trình duyệt vẫn có thể không giải phóng bộ nhớ liên kết với vùng quảng cáo đó nếu trang của nhà xuất bản vẫn duy trì tham chiếu đến vùng quảng cáo đó. Khi bạn gọi API này, div liên kết với vùng quảng cáo đó sẽ có thể được sử dụng lại.

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

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 vị trí cần huỷ. Mảng là không bắt buộc; tất cả các vị trí sẽ bị huỷ nếu không được chỉ định.

Giá trị trả về
boolean	true nếu vị trí đã 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ụ vùng quảng cáo hiển thị vùng quảng cáo. Mỗi vị trí quảng cáo chỉ được hiển thị một lần trên mỗi trang. Tất cả khung giờ phải được xác định và có một dịch vụ liên kết với khung giờ đó trước khi hiển thị. Lệnh gọi hiển thị chỉ được thực hiệ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 tên trong lệnh gọi phương thức.

Nếu đang sử dụng cấu trúc yêu cầu duy nhất (SRA), thì tất cả các vị trí quảng cáo chưa được tìm nạp tại thời điểm phương thức này được gọi sẽ được tìm nạp cùng một lúc. Để buộc một vị trí 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ùng. Nếu bạn cung cấp một phần tử div, thì phần tử đó phải có thuộc tính "id" khớp với mã nhận dạng được truyền vào defineSlot.

---

enableServices

enableServices(): void

Bật tất cả các dịch vụ GPT đã được xác định cho vị trí quảng cáo trên trang.

---

getConfig

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

Lấy bản sao cố định của các tuỳ chọn cấu hình chung cho trang do setConfig đặt.

Phương thức này không hỗ trợ một số 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 tuỳ chọn cấu hình cần lấy.

Giá trị trả về
Readonly<Pick<PageSettingsConfig, "adsenseAttributes" | "disableInitialLoad" | "targeting">>	Bản sao cố định của các tuỳ chọn cấu hình cho trang.

---

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 đ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ã div của vị trí quảng cáo. Giá trị này 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ở ra cùng với thông tin chi tiết về vị trí quảng cáo được chỉ định trong chế độ xem.

---

pubads

pubads(): PubAdsService

Trả về thông tin 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, 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 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 hàm và gọi các hàm đó theo thứ tự. Mảng này dùng để thay thế một mảng chuẩn được dùng để đưa các hàm vào hàng đợi để gọi sau khi GPT được tải.

Phương thức
push	Thực thi chuỗi 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)[]	Hàm JavaScript cần 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 nay. Đ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

Kéo dài Service

Dịch vụ Quảng cáo đồng hành. Quảng cáo dạng video sử dụng dịch vụ này để 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. Được kế thừa từ phương thức Service.addEventListener
getSlots	Lấy danh sách khung giờ liên kết với dịch vụ này. Được kế thừa từ phương thức Service.getSlots
removeEventListener	Xoá trình nghe đã đăng ký trước đó. Được kế thừa từ phương thức Service.removeEventListener
setRefreshUnfilledSlots	Đặt xem vùng quảng cáo đồng hành chưa được lấp đầy có tự động được 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 suốt thời gian hoạt động 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ý với 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ế để lấp đầy các vùng quảng cáo đồng hành trống khi video 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 lấp đầy các vị trí chưa được lấp đầy, 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ý là dành cho trẻ em hay không.
limitedAds?	Cho phép phân phát quảng cáo ở chế độ quảng cáo bị hạn chế để hỗ trợ nhà xuất bản tuân thủ quy định.
nonPersonalizedAds?	Cho phép phân phát quảng cáo ở chế độ quảng cáo không được cá nhân hoá để giúp nhà xuất bản đáp ứng các yêu cầu tuân thủ quy định.
restrictDataProcessing?	Cho phép phân phát quảng cáo ở chế độ xử lý bị hạn chế để giúp nhà xuất bản tuân thủ quy định.
tagForAgeTreatment?	Chế độ xử lý theo độ tuổi, cho biết liệu yêu cầu quảng cáo có nên được coi là dành cho trẻ em, thanh thiếu niên hay không xác định.
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 liệu có đánh dấu yêu cầu quảng cáo là đến từ 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ý là 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 quảng cáo ở chế độ quảng cáo bị hạn chế để hỗ trợ nhà xuất bản tuân thủ quy định.

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ế. Nếu bạn cố gắng sửa đổi chế độ cài đặt này khi GPT đã được tải từ URL chuẩn, thì hệ thống sẽ tạo ra một cảnh báo trong 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 quảng cáo ở chế độ quảng cáo không được cá nhân hoá để giúp nhà xuất bản tuân thủ quy định.

---

Optional restrictDataProcessing

restrictDataProcessing?: boolean

Cho phép phân phát quảng cáo ở chế độ xử lý bị hạn chế để giúp nhà xuất bản tuân thủ quy định.

---

Optional tagForAgeTreatment

tagForAgeTreatment?: TagForAgeTreatment

Chế độ xử lý theo độ tuổi, cho biết yêu cầu quảng cáo nên được xử lý là dành cho trẻ em, thanh thiếu niên hay không xác định.

Hãy tham khảo ý kiến của cố vấn pháp lý để xác định chế độ xử lý theo độ tuổi cho người dùng dựa trên các yêu cầu pháp lý và quy định. Để biết thêm thông tin về chế độ cài đặt này, hãy xem bài viết trên Trung tâm trợ giúp này.

Bằng việc đặt thuộc tính này, bạn xác nhận rằng thông báo này là chính xác và bạn được uỷ quyền hành động thay mặt cho chủ sở hữu trang web. Bạn hiểu rằng nếu bạn sử dụng chế độ cài đặt này sai mục đích, thì Tài khoản Google của bạn có thể sẽ ngừng hoạt động.

Ví dụ

JavaScript

// Enable teen privacy treatment.
googletag.pubads().setPrivacySettings({
  tagForAgeTreatment: googletag.enums.TagForAgeTreatment.TEEN,
});

// Clear age treatment configuration.
googletag.pubads().setPrivacySettings({
  tagForAgeTreatment: googletag.enums.TagForAgeTreatment.UNSPECIFIED,
});

JavaScript (cũ)

// Enable teen privacy treatment.
googletag.pubads().setPrivacySettings({
  tagForAgeTreatment: googletag.enums.TagForAgeTreatment.TEEN,
});

// Clear age treatment configuration.
googletag.pubads().setPrivacySettings({
  tagForAgeTreatment: googletag.enums.TagForAgeTreatment.UNSPECIFIED,
});

TypeScript

// Enable teen privacy treatment.
googletag.pubads().setPrivacySettings({
  tagForAgeTreatment: googletag.enums.TagForAgeTreatment.TEEN,
});

// Clear age treatment configuration.
googletag.pubads().setPrivacySettings({
  tagForAgeTreatment: googletag.enums.TagForAgeTreatment.UNSPECIFIED,
});

---

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 vào 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 liệu có đánh dấu yêu cầu quảng cáo là đến từ 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

Kéo dài 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. Được kế thừa từ phương thức 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ị trí để chúng không chiếm không gian 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 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ị trí quảng cáo có đường dẫn và kích thước đơn vị quảng cáo đã cho.
enableLazyLoad	Không dùng nữa. Bật tính năng tải chậm trong GPT theo định nghĩa của đối tượng cấu hình.
enableSingleRequest	Không dùng nữa. Bật chế độ một yêu cầu để 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 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 khung giờ liên kết với dịch vụ này. Được kế thừa từ phương thức Service.getSlots
getTargeting	Không dùng nữa. Trả về một tham số nhắm mục tiêu cấp dịch vụ tuỳ chỉnh cụ thể đã được đặ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 cấp dịch vụ tuỳ chỉnh đã được đặt.
isInitialLoadDisabled	Không dùng nữa. Trả về việc các yêu cầu ban đầu cho quảng cáo có bị vô hiệu hoá thành công bởi lệnh gọi PubAdsService.disableInitialLoad trước đó hay không.
refresh	Tìm nạp và hiển thị quảng cáo mới cho các vùng quảng cáo cụ thể hoặc tất cả vùng quảng cáo trên trang.
registerRequestHook	Đăng ký một hook để thực thi song song với các hook đã đăng ký khác trước mỗi yêu cầu quảng cáo trên trang trong khoảng thời gian chờ chung.
removeEventListener	Xoá trình nghe đã đăng ký trước đó. Được kế thừa từ phương thức Service.removeEventListener
set	Không dùng nữa. Đặt giá trị cho các thuộc tính AdSense áp dụng cho tất cả vị trí 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 vùng chứa SafeFrame hay không.
setLocation	Không dùng nữa. Chuyể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 các vị trí cụ thể.
setPrivacySettings	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 đố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 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 tham số nhắm mục tiêu tùy chỉnh cho một khóa nhất định áp dụng cho tất cả các vị trí 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 cần gửi cùng với 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 yêu cầu quảng cáo, bắt đầu một lượt xem trang mới một cách hiệu quả.

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ùng quảng cáo sẽ được đánh dấu là chưa tìm nạp.

Cụ thể, việc xoá một vùng quảng cáo sẽ xoá quảng cáo khỏi lượt xem trang dài hạn của GPT, vì vậy, các yêu cầu trong tương lai sẽ không bị ảnh hưởng bởi quảng cáo xuất hiện trên nhiều vị trí 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 vị trí cần xoá. Mảng là không bắt buộc; tất cả các vùng quảng cáo sẽ bị xoá nếu không được chỉ định.

Giá trị trả về
boolean	Trả về true nếu các vùng quảng cáo đã đượ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 rất hữu ích nếu bạn muốn làm mới vùng quảng cáo.

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

Ví dụ

JavaScript

// Set category exclusion to exclude ads with 'AirlineAd' labels.
googletag.setConfig({
  categoryExclusion: ["AirlineAd"],
});

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

// Clear category exclusions so all ads can be returned.
googletag.setConfig({
  categoryExclusion: null,
});

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

JavaScript (cũ)

// Set category exclusion to exclude ads with 'AirlineAd' labels.
googletag.setConfig({
  categoryExclusion: ["AirlineAd"],
});

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

// Clear category exclusions so all ads can be returned.
googletag.setConfig({
  categoryExclusion: null,
});

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

TypeScript

// Set category exclusion to exclude ads with 'AirlineAd' labels.
googletag.setConfig({
  categoryExclusion: ["AirlineAd"],
});

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

// Clear category exclusions so all ads can be returned.
googletag.setConfig({
  categoryExclusion: null,
});

// 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 tham 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: Hãy sử dụng PageSettingsConfig.targeting để thay thế.

Ví dụ

JavaScript

googletag.setConfig({
  targeting: {
    interests: "sports",
    colors: "blue",
    fruits: "apple",
  },
});

googletag.setConfig({
  targeting: {
    interests: null,
  },
});
// Targeting 'colors' and 'fruits' are still present, while 'interests'
// was cleared.

googletag.setConfig({
  targeting: null,
});
// All targeting has been cleared.

JavaScript (cũ)

googletag.setConfig({
  targeting: {
    interests: "sports",
    colors: "blue",
    fruits: "apple",
  },
});

googletag.setConfig({
  targeting: {
    interests: null,
  },
});
// Targeting 'colors' and 'fruits' are still present, while 'interests'
// was cleared.

googletag.setConfig({
  targeting: null,
});
// All targeting has been cleared.

TypeScript

googletag.setConfig({
  targeting: {
    interests: "sports",
    colors: "blue",
    fruits: "apple",
  },
});

googletag.setConfig({
  targeting: {
    interests: null,
  },
});
// Targeting 'colors' and 'fruits' are still present, while 'interests'
// was cleared.

googletag.setConfig({
  targeting: null,
});
// All targeting has been cleared.

Xem thêm

• Nhắm mục tiêu theo 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 tham số nhắm mục tiêu sẽ bị xoá nếu bạn không chỉ định khoá này.

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ị trí quảng cáo để chúng không chiếm không gian 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: Hãy sử dụng PageSettingsConfig.collapseDiv để thay thế.

Xem thêm

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

Thông số
Optional collapseBeforeAdFetch: boolean	Có thu gọn vị trí ngay cả trước khi tìm nạp quảng cáo hay không. Tham số này không bắt buộc; nếu không được 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 được gọi sau khi dịch vụ được bật.

---

disableInitialLoad

disableInitialLoad(): void

Tắt 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. Bạn nên đặt giá trị 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 refresh.

Không dùng nữa: Hãy sử dụng PageSettingsConfig.disableInitialLoad để thay thế.

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 phân 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ị trí quảng cáo có đường dẫn và kích thước đơn vị quảng cáo đã cho.

Phương thức này là một cách viết tắt tương đương với việc gọi googletag.defineSlot ngay sau googletag.display.

Hành vi của phương thức này phụ thuộc vào việc Cấu trúc yêu cầu duy nhất (SRA) có được bật hay không:

• Đã bật SRA: Tất cả vị trí quảng cáo được xác định cho đến thời điểm của lệnh gọi này sẽ được gộp và yêu cầu cùng nhau.
• SRA bị tắt (mặc định): Vị trí quảng cáo sẽ được yêu cầu riêng lẻ.

Lưu ý: Khi phương thức này được gọi, ả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 đố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ư, buộc sử dụng SafeFrame, 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 đơ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 vùng quảng cáo.
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 nhấp chuột để sử dụng trên vùng quảng cáo này.

---

enableLazyLoad

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

Bật tính năng tải chậm trong GPT theo định nghĩa của đối tượng cấu hình. Để biết thêm ví dụ chi tiết, hãy xem mẫu tải chậm.

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ùng quảng cáo đều nằm ngoài biên tìm nạp.

Không dùng nữa: Hãy sử dụng PageSettingsConfig.lazyLoad thay thế.

Ví dụ

JavaScript

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

JavaScript (cũ)

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

TypeScript

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

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 chậm

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 tải từng phần. Mọi cấu hình bị bỏ qua sẽ sử dụng một tập hợp 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ư biên độ tìm nạp, hãy đặt giá trị thành -1. fetchMarginPercent Khoảng cách tối thiểu từ khung nhìn hiện tại mà một vùng quảng cáo 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 nhìn. 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 nhìn", v.v. 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. Đ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 nhìn. mobileScaling Hệ số nhân áp dụng cho lề trên thiết bị di động. Điều này cho phép 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ả lề với 2 trên thiết bị di động, tăng khoảng cách tối thiểu mà một vị trí có thể có trước khi tìm nạp và hiển thị.

---

enableSingleRequest

enableSingleRequest(): boolean

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

Không dùng nữa: Hãy sử dụng PageSettingsConfig.singleRequest để thay thế.

Xem thêm

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

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

---

enableVideoAds

enableVideoAds(): void

Báo hiệu cho GPT biết rằng quảng cáo dạng video sẽ xuất hiện trên trang. Nhờ đó, các quy tắc ràng buộc về loại trừ cạnh tranh sẽ có hiệu lực trên cả 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 tiêu chí loại trừ nội dung cho quảng cáo hiển thị.

Không dùng nữa: 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 sử dụng googletag.getConfig.

Ví dụ

JavaScript

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
  },
});

const adsenseConfig = googletag.getConfig("adsenseAttributes").adsenseAttributes;
const pageUrl = adsenseConfig?.page_url || null;
// Returns 'http://www.example.com'.

JavaScript (cũ)

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
  },
});

var adsenseConfig = googletag.getConfig("adsenseAttributes").adsenseAttributes;
var pageUrl =
  (adsenseConfig === null || adsenseConfig === void 0 ? void 0 : adsenseConfig.page_url) || null;
// Returns 'http://www.example.com'.

TypeScript

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
  },
});

const adsenseConfig = googletag.getConfig("adsenseAttributes").adsenseAttributes;
const pageUrl = adsenseConfig?.page_url || null;
// Returns 'http://www.example.com'.

Xem thêm

• Thuộc tính trong 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 của khoá thuộc tính hoặc null nếu không có khoá.

---

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.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
    document_language: "en",
  },
});

const adsenseConfig = googletag.getConfig("adsenseAttributes").adsenseAttributes;
const adsenseAttributes = Object.keys(adsenseConfig || {});
// Returns ['page_url', 'document_language'].

JavaScript (cũ)

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
    document_language: "en",
  },
});

var adsenseConfig = googletag.getConfig("adsenseAttributes").adsenseAttributes;
var adsenseAttributes = Object.keys(adsenseConfig || {});
// Returns ['page_url', 'document_language'].

TypeScript

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
    document_language: "en",
  },
});

const adsenseConfig = googletag.getConfig("adsenseAttributes").adsenseAttributes;
const adsenseAttributes = Object.keys(adsenseConfig || {});
// Returns ['page_url', 'document_language'].

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 cấp dịch vụ tuỳ chỉnh cụ thể đã được đặt.

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

Ví dụ

JavaScript

googletag.setConfig({
  targeting: {
    interests: "sports",
  },
});

const targetingConfig = googletag.getConfig("targeting").targeting;

// Get targeting for a specific key.
const targeting = targetingConfig?.["interests"] || [];
// Returns ['sports'].

const ageTargeting = targetingConfig?.["age"] || [];
// Returns [] (empty array).

JavaScript (cũ)

googletag.setConfig({
  targeting: {
    interests: "sports",
  },
});

var targetingConfig = googletag.getConfig("targeting").targeting;

// Get targeting for a specific key.
var targeting =
  (targetingConfig === null || targetingConfig === void 0
    ? void 0
    : targetingConfig["interests"]) || [];
// Returns ['sports'].

var ageTargeting =
  (targetingConfig === null || targetingConfig === void 0 ? void 0 : targetingConfig["age"]) || [];
// Returns [] (empty array).

TypeScript

googletag.setConfig({
  targeting: {
    interests: "sports",
  },
});

const targetingConfig = googletag.getConfig("targeting").targeting;

// Get targeting for a specific key.
const targeting = targetingConfig?.["interests"] || [];
// Returns ['sports'].

const ageTargeting = targetingConfig?.["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ị 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 cấp dịch vụ tuỳ chỉnh đã được đặt.

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

Ví dụ

JavaScript

googletag.setConfig({
  targeting: {
    interests: "sports",
    colors: "blue",
  },
});

const targetingConfig = googletag.getConfig("targeting").targeting;
const keys = Object.keys(targetingConfig || {});
// Returns ['interests', 'colors'].

JavaScript (cũ)

googletag.setConfig({
  targeting: {
    interests: "sports",
    colors: "blue",
  },
});

var targetingConfig = googletag.getConfig("targeting").targeting;
var keys = Object.keys(targetingConfig || {});
// Returns ['interests', 'colors'].

TypeScript

googletag.setConfig({
  targeting: {
    interests: "sports",
    colors: "blue",
  },
});

const targetingConfig = googletag.getConfig("targeting").targeting;
const keys = Object.keys(targetingConfig || {});
// 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 cho quảng cáo có bị vô hiệu hoá thành công bởi lệnh gọi PubAdsService.disableInitialLoad trước đó hay không.

Không dùng nữa: Thay vào đó, 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 các vùng quảng cáo cụ thể hoặc tất cả vùng quảng cáo trên trang. Chỉ hoạt động ở chế độ hiển thị 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ị trí quảng cáo. Nếu lệnh gọi đến display bị bỏ qua, thì thao tác 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ị trí sẽ xoá quảng cáo cũ khỏi lượt xem trang dài hạn của GPT, vì vậy, các yêu cầu trong tương lai sẽ không bị ảnh hưởng bởi các quy tắc 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ị trí quảng cáo

Thông số
Optional slots: Slot[]	Vị trí cần làm mới. Mảng là không bắt buộc; tất cả các vùng quảng cáo sẽ được làm mới nếu không được chỉ định.
Optional options: {   changeCorrelator: boolean; }	Các tuỳ 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 xem có tạo một trình 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. Theo mặc định, một giá trị 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 lâu dài của GPT, tự động phản ánh quảng cáo hiện có trên trang và không có thời gian hết hạn.

---

registerRequestHook

registerRequestHook(hook: RequestHook, hookId: string): (() => void)

Experimental Đăng ký một hook để thực thi song song với các hook đã đăng ký khác trước mỗi yêu cầu quảng cáo trên trang trong thời gian chờ chung.

Ví dụ

JavaScript

// Register a request hook.
const unregister = googletag.pubads().registerRequestHook(async ({ slots }) => {
  const someAsynchronousAction = Promise.resolve();
  await someAsynchronousAction;
  for (const slot of slots) {
    slot.setConfig({ targeting: { hookApplied: "true" } });
  }
}, "my-hook");

// Unregister the hook.
unregister();

JavaScript (cũ)

// Coming soon.

TypeScript

// Register a request hook.
const unregister = googletag.pubads().registerRequestHook(async ({ slots }) => {
  const someAsynchronousAction = Promise.resolve();
  await someAsynchronousAction;
  for (const slot of slots) {
    slot.setConfig({ targeting: { hookApplied: "true" } });
  }
}, "my-hook");

// Unregister the hook.
unregister();

Thông số
hook: RequestHook	Một hàm nhận một đối tượng chứa danh sách các vị trí được yêu cầu và trả về một lời hứa sẽ phân giải sau khi tất cả các hành động không đồng bộ hoàn tất.
hookId: string	Mã nhận dạng để gắn nhãn hook nhằm cải thiện khả năng chẩn đoán.

Giá trị trả về
(() => void)	Một hàm để huỷ đăng ký hook.

---

set

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

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

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

Không dùng nữa: Hãy sử dụng PageSettingsConfig.adsenseAttributes để thay thế.

Ví dụ

JavaScript

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
  },
});

JavaScript (cũ)

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
  },
});

TypeScript

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
  },
});

Xem thêm

• Thuộc tính trong 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: Hãy sử dụng PageSettingsConfig.categoryExclusion.

Ví dụ

JavaScript

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

JavaScript (cũ)

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

TypeScript

// Label = AirlineAd.
googletag.setConfig({
  categoryExclusion: ["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. Tính năng căn giữa bị tắt theo mặc định. Trong gpt_mobile.js cũ, tính năng căn giữa được bật theo mặc định.

Bạn nên gọi phương thức này 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: Hãy sử dụng PageSettingsConfig.centering.

Ví dụ

JavaScript

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

JavaScript (cũ)

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

TypeScript

// Make ads centered.
googletag.setConfig({
  centering: 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 có nên buộc tất cả quảng cáo trên trang hiển thị bằng vùng chứa SafeFrame hay không.

Vui lòng lưu ý những điều sau 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.
• Chế độ cài đặt cấp vị trí, nếu được chỉ định, 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), thì 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 được thực hiện trong giao diện người dùng Google Ad Manager.
• Tuy nhiên, nếu bạn đặt thành false hoặc không chỉ định, thì quảng cáo sẽ 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 trong giao diện người dùng Google Ad Manager.
• Bạn nên thận trọng khi sử dụng API này 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 mẫu quảng cáo được hiển thị trực tiếp trên trang của nhà xuất bản.

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

Ví dụ

JavaScript

googletag.setConfig({
  safeFrame: {
    forceSafeFrame: true,
  },
});

// The following slot will be opted-out of the page-level force
// SafeFrame instruction.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setConfig({
    safeFrame: {
      forceSafeFrame: 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.setConfig({
  safeFrame: {
    forceSafeFrame: true,
  },
});

// The following slot will be opted-out of the page-level force
// SafeFrame instruction.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setConfig({
    safeFrame: {
      forceSafeFrame: 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.setConfig({
  safeFrame: {
    forceSafeFrame: true,
  },
});

// The following slot will be opted-out of the page-level force
// SafeFrame instruction.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setConfig({
    safeFrame: {
      forceSafeFrame: 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 phải hiển thị trong SafeFrame và false để thay đổi chế độ cài đặt trước đó thành false. Việc đặt giá trị này thành false khi chưa được chỉ định trước đó sẽ không thay đổi bất cứ điều gì.

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

---

setLocation

setLocation(address: string): PubAdsService

Chuyể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: Hãy sử dụng PageSettingsConfig.location để thay thế.

Ví dụ

JavaScript

// Postal code:
googletag.setConfig({
  location: "10001,US",
});

JavaScript (cũ)

// Postal code:
googletag.setConfig({
  location: "10001,US",
});

TypeScript

// Postal code:
googletag.setConfig({
  location: "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 đố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ã nhận dạng gồm chữ và số do nhà xuất bản cung cấp. Phải có từ 22 đế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 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ằng 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: Thay vào đó, hãy sử dụng PageSettingsConfig.safeFrame.

Ví dụ

JavaScript

googletag.setConfig({
  safeFrame: {
    forceSafeFrame: true,
    allowOverlayExpansion: true,
    allowPushExpansion: true,
    sandbox: true,
  },
});

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setConfig({
    safeFrame: {
      allowOverlayExpansion: false,
    },
  })
  .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.setConfig({
  safeFrame: {
    forceSafeFrame: true,
    allowOverlayExpansion: true,
    allowPushExpansion: true,
    sandbox: true,
  },
});

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setConfig({
    safeFrame: {
      allowOverlayExpansion: false,
    },
  })
  .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.setConfig({
  safeFrame: {
    forceSafeFrame: true,
    allowOverlayExpansion: true,
    allowPushExpansion: true,
    sandbox: true,
  },
});

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setConfig({
    safeFrame: {
      allowOverlayExpansion: false,
    },
  })
  .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 tham số nhắm mục tiêu tùy chỉnh cho một khoá nhất định áp dụng cho tất cả các vị trí quảng cáo của dịch vụ Quảng cáo của nhà xuất bản. Việc gọi hàm 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.setConfig({
  targeting: {
    interests: "sports",
  },
});

// Example with multiple values for a key inside in an array.
googletag.setConfig({
  targeting: {
    interests: ["sports", "music"],
  },
});

JavaScript (cũ)

// Example with a single value for a key.
googletag.setConfig({
  targeting: {
    interests: "sports",
  },
});

// Example with multiple values for a key inside in an array.
googletag.setConfig({
  targeting: {
    interests: ["sports", "music"],
  },
});

TypeScript

// Example with a single value for a key.
googletag.setConfig({
  targeting: {
    interests: "sports",
  },
});

// Example with multiple values for a key inside in an array.
googletag.setConfig({
  targeting: {
    interests: ["sports", "music"],
  },
});

Xem thêm

• Nhắm mục tiêu theo 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 nội dung video sẽ được gửi cùng với 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ụ phân tích nội dung của Google Ad Manager.

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

Xem thêm

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

Thông số
videoContentId: string	Mã Content ID của nội dung video.
videoCmsId: string	Mã CMS của video.

---

updateCorrelator

updateCorrelator(): PubAdsService

Thay đổi giá trị tương quan được gửi cùng với yêu cầu quảng cáo, bắt đầu một lượt xem trang mới một cách hiệu quả. Giá trị tương quan là như nhau đối với 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 cho mỗi lượt xem trang. Chỉ áp dụng cho chế độ không đồng bộ.

Lưu ý: điều này không ảnh hưởng đến lượt xem trang lâu dài của GPT, tự động phản ánh 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.RequestHook

Hàm callback được gọi trước mỗi yêu cầu quảng cáo khi được đăng ký qua PubAdsService.registerRequestHook.

---

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ã nhận dạng của nhà quảng cáo.
campaignId	Mã của 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ã của mục hàng.

Xem thêm

• Slot.getResponseInformation

Thuộc tính

---

advertiserId

advertiserId: number

Mã nhận dạng của nhà quảng cáo.

---

campaignId

campaignId: number

Mã của 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ã 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 quảng cáo có tặng thưởng

Thuộc tính
amount	Số lượng vật phẩm trong phần thưởng.
type	Loại vật phẩm 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

---

amount

amount: number

Số lượng vật phẩm trong phần thưởng.

---

type

type: string

Loại vật phẩm 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ả 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 khung giờ liên kết với dịch vụ này.
removeEventListener	Xoá 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 đượ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 đại diện cho 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 khung giờ 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á 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 đại diện cho 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 thông số kỹ thuật á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ối liên kết từ một mảng kích thước đơn (đại diện cho khung nhìn) vào một mảng kích thước đơn hoặc đa kích thước đại diện cho vùng quảng cáo.
build	Tạo thông số kỹ thuật của 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ối liên kết từ một mảng kích thước đơn (đại diện cho khung nhìn) vào một mảng kích thước đơn hoặc đa 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 của khung nhìn cho mục ánh xạ này.
slotSize: GeneralSize	Kích thước của vị trí cho mục ánh xạ này.

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

---

bản dựng

build(): SizeMappingArray

Tạo thông số kỹ thuật ánh xạ 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 có bất kỳ mối liên kết không hợp lệ nào được cung cấp, thì phương thức này sẽ trả về null. Nếu không, phương thức này sẽ trả về một thông số kỹ thuật ở đị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ể 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ị trí là một đối tượng đại diện cho một vị trí quảng cáo 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ị trí cho vị trí này.
clearTargeting	Không dùng nữa. Xoá các tham số nhắm mục tiêu cấp vùng quảng cáo tuỳ chỉnh cụ thể hoặc tất cả các tham số nhắm mục tiêu cấp vùng quảng cáo tuỳ chỉnh cho vùng quảng cáo này.
defineSizeMapping	Đặt một mảng ánh xạ từ kích thước khung nhìn 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 liên kết với khoá đã cho cho vùng này.
getAdUnitPath	Trả về đường dẫn đầy đủ của đơn vị quảng cáo, cùng với 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 vùng quảng cáo 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ị trí này.
getConfig	Lấy bản sao cố định của các tuỳ chọn cấu hình chung cho vùng quảng cáo do setConfig đặt.
getResponseInformation	Trả về thông tin phản hồi quảng cáo.
getSlotElementId	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.
getTargeting	Không dùng nữa. Trả về một thông số nhắm mục tiêu tùy chỉnh cụ thể được đặt trên vùng quảng cáo 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 tùy chỉnh được đặt trên vùng này.
set	Không dùng nữa. Đặt giá trị cho thuộc tính AdSense trên vị trí 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í quảng cáo cho vị trí quảng cáo 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 vị trí div có bị ẩn khi không có quảng cáo trong vị trí đó hay không.
setConfig	Đặt các lựa chọn cấu hình chung cho vùng quảng cáo 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 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 tham số nhắm mục tiêu tùy chỉnh cho vùng quảng cáo này.
updateTargetingFromMap	Không dùng nữa. Đặt tham số nhắm mục tiêu tùy chỉnh cho vùng quảng cáo này, từ bản đồ khoá-giá trị trong đố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 vùng quảng cáo 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 để thay thế.

Ví dụ

JavaScript

// Set category exclusion to exclude ads with 'AirlineAd' labels.
const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    categoryExclusion: ["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.setConfig({
  categoryExclusion: null,
});

// 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")
  .setConfig({
    categoryExclusion: ["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.setConfig({
  categoryExclusion: null,
});

// 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")!
  .setConfig({
    categoryExclusion: ["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.setConfig({
  categoryExclusion: null,
});

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

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

---

clearTargeting

clearTargeting(key?: string): Slot

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

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")
  .setConfig({
    targeting: {
      allow_expandable: "true",
      interests: ["sports", "music"],
      color: "red",
    },
  })
  .addService(googletag.pubads());

slot.setConfig({
  targeting: {
    color: null,
  },
});
// Targeting 'allow_expandable' and 'interests' are still present,
// while 'color' was cleared.

slot.setConfig({
  targeting: null,
});
// All targeting has been cleared.

JavaScript (cũ)

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

slot.setConfig({
  targeting: {
    color: null,
  },
});
// Targeting 'allow_expandable' and 'interests' are still present,
// while 'color' was cleared.

slot.setConfig({
  targeting: null,
});
// All targeting has been cleared.

TypeScript

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

slot.setConfig({
  targeting: {
    color: null,
  },
});
// Targeting 'allow_expandable' and 'interests' are still present,
// while 'color' was cleared.

slot.setConfig({
  targeting: null,
});
// All targeting has been cleared.

Xem thêm

• Nhắm mục tiêu theo 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 tham số nhắm mục tiêu sẽ bị xoá nếu bạn không chỉ định khoá này.

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

---

defineSizeMapping

defineSizeMapping(sizeMapping: SizeMappingArray): Slot

Đặt một mảng ánh xạ từ kích thước khung nhìn 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 hai phần tử: SingleSizeArray và GeneralSize.

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

---

get

get(key: string): string

Trả về giá trị cho thuộc tính AdSense liên kết với khoá đã cho cho vùng 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")
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
    },
  })
  .addService(googletag.pubads());

const adsenseConfig = slot.getConfig("adsenseAttributes").adsenseAttributes;
const pageUrl = adsenseConfig?.page_url || null;
// Returns 'http://www.example.com'.

JavaScript (cũ)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
    },
  })
  .addService(googletag.pubads());

var adsenseConfig = slot.getConfig("adsenseAttributes").adsenseAttributes;
var pageUrl =
  (adsenseConfig === null || adsenseConfig === void 0 ? void 0 : adsenseConfig.page_url) || null;
// Returns 'http://www.example.com'.

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
    },
  })
  .addService(googletag.pubads());

const adsenseConfig = slot.getConfig("adsenseAttributes").adsenseAttributes;
const pageUrl = adsenseConfig?.page_url || null;
// Returns 'http://www.example.com'.

Xem thêm

• Thuộc tính trong 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 của khoá thuộc tính hoặc null nếu không có khoá.

---

getAdUnitPath

getAdUnitPath(): string

Trả về đường dẫn đầy đủ của đơn vị quảng cáo, cùng với 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 vùng này. Để xem khoá của các thuộc tính cấp dịch vụ mà vùng quảng cáo này kế thừa, hãy sử dụng PubAdsService.getAttributeKeys.

Không dùng nữa: Hãy sử dụng googletag.Slot.getConfig để thay thế.

Ví dụ

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
      document_language: "en",
    },
  })
  .addService(googletag.pubads());

const adsenseConfig = slot.getConfig("adsenseAttributes").adsenseAttributes;
const adsenseAttributes = Object.keys(adsenseConfig || {});
// Returns ['page_url', 'document_language'].

JavaScript (cũ)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
      document_language: "en",
    },
  })
  .addService(googletag.pubads());

var adsenseConfig = slot.getConfig("adsenseAttributes").adsenseAttributes;
var adsenseAttributes = Object.keys(adsenseConfig || {});
// Returns ['page_url', 'document_language'].

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
      document_language: "en",
    },
  })
  .addService(googletag.pubads());

const adsenseConfig = slot.getConfig("adsenseAttributes").adsenseAttributes;
const adsenseAttributes = Object.keys(adsenseConfig || {});
// Returns ['page_url', 'document_language'].

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")
  .setConfig({
    categoryExclusion: ["AirlineAd", "TrainAd"],
  })
  .addService(googletag.pubads());

const exclusions = slot.getConfig("categoryExclusion")?.categoryExclusion || [];
// Returns ['AirlineAd', 'TrainAd'].

JavaScript (cũ)

var _a;
var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    categoryExclusion: ["AirlineAd", "TrainAd"],
  })
  .addService(googletag.pubads());

var exclusions =
  ((_a = slot.getConfig("categoryExclusion")) === null || _a === void 0
    ? void 0
    : _a.categoryExclusion) || [];
// Returns ['AirlineAd', 'TrainAd'].

TypeScript

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

const exclusions = slot.getConfig("categoryExclusion")?.categoryExclusion || [];
// Returns ['AirlineAd', 'TrainAd'].

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

---

getConfig

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

Lấy bản sao cố định của các tuỳ chọn cấu hình chung cho vùng quảng cáo 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
• 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 tuỳ chọn cấu hình cần lấy.

Giá trị trả về
Readonly<Pick<SlotSettingsConfig, "adsenseAttributes" | "targeting" | "categoryExclusion">>	Bản sao cố định của các tuỳ chọn cấu hình cho vùng quảng cáo.

---

getResponseInformation

getResponseInformation(): ResponseInformation

Trả về thông tin 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í quảng cáo. Nếu hàm này được gọi khi vị trí không có quảng cáo, thì null sẽ được trả về.

Giá trị trả về
ResponseInformation	Thông tin phản hồi quảng cáo mới nhất 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 của ô div.

---

getTargeting

getTargeting(key: string): string[]

Trả về một thông số nhắm mục tiêu tùy chỉnh cụ thể được đặt trên vùng quảng cáo này. Không bao gồm 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")
  .setConfig({
    targeting: {
      allow_expandable: "true",
    },
  })
  .addService(googletag.pubads());

const targetingConfig = slot.getConfig("targeting").targeting;

// Get targeting for a specific key.
const targeting = targetingConfig?.["allow_expandable"] || [];
// Returns ['true'].

const ageTargeting = targetingConfig?.["age"] || [];
// Returns [] (empty array).

JavaScript (cũ)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    targeting: {
      allow_expandable: "true",
    },
  })
  .addService(googletag.pubads());

var targetingConfig = slot.getConfig("targeting").targeting;

// Get targeting for a specific key.
var targeting =
  (targetingConfig === null || targetingConfig === void 0
    ? void 0
    : targetingConfig["allow_expandable"]) || [];
// Returns ['true'].

var ageTargeting =
  (targetingConfig === null || targetingConfig === void 0 ? void 0 : targetingConfig["age"]) || [];
// Returns [] (empty array).

TypeScript

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

const targetingConfig = slot.getConfig("targeting").targeting;

// Get targeting for a specific key.
const targeting = targetingConfig?.["allow_expandable"] || [];
// Returns ['true'].

const ageTargeting = targetingConfig?.["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ị 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ùng quảng cáo 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")
  .setConfig({
    targeting: {
      allow_expandable: "true",
      interests: ["sports", "music"],
    },
  })
  .addService(googletag.pubads());

const targetingConfig = slot.getConfig("targeting").targeting;
const keys = Object.keys(targetingConfig || {});
// Returns ['interests', 'allow_expandable'].

JavaScript (cũ)

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

var targetingConfig = slot.getConfig("targeting").targeting;
var keys = Object.keys(targetingConfig || {});
// Returns ['interests', 'allow_expandable'].

TypeScript

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

const targetingConfig = slot.getConfig("targeting").targeting;
const keys = Object.keys(targetingConfig || {});
// 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 giá trị cho thuộc tính AdSense trên vị trí 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.

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ị đã đặt trước đó cho khoá đó. Bạn phải đặt tất 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 để thay thế.

Ví dụ

JavaScript

// Setting an attribute on a single ad slot.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
    },
  })
  .addService(googletag.pubads());

JavaScript (cũ)

// Setting an attribute on a single ad slot.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
    },
  })
  .addService(googletag.pubads());

TypeScript

// Setting an attribute on a single ad slot.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
    },
  })
  .addService(googletag.pubads());

Xem thêm

• Thuộc tính trong 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 vùng quảng cáo 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: Thay vào đó, hãy sử dụng SlotSettingsConfig.categoryExclusion.

Ví dụ

JavaScript

// Label = AirlineAd.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    categoryExclusion: ["AirlineAd"],
  })
  .addService(googletag.pubads());

JavaScript (cũ)

// Label = AirlineAd.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    categoryExclusion: ["AirlineAd"],
  })
  .addService(googletag.pubads());

TypeScript

// Label = AirlineAd.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    categoryExclusion: ["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 vùng quảng cáo 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.

Máy chủ Google Ad Manager vẫn ghi lại một lượt nhấp ngay cả khi URL nhấp chuột được thay thế. Mọi URL trang đích 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ị đã cung cấp. Các lệnh gọi tiếp theo sẽ ghi đè giá trị. Phương thức 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")
  .setConfig({
    clickUrl: "http://www.example.com?original_click_url=",
  })
  .addService(googletag.pubads());

JavaScript (cũ)

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

TypeScript

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

Thông số
value: string	URL nhấp cần đặt.

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

---

setCollapseEmptyDiv

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

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

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

Ví dụ

JavaScript

const slot1 = googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setConfig({
    collapseDiv: "BEFORE_FETCH",
  })
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// when the page is loaded, before ads are requested.

const slot2 = googletag
  .defineSlot("/1234567/sports", [160, 600], "div-2")
  .setConfig({
    collapseDiv: "ON_NO_FILL",
  })
  .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ũ)

var slot1 = googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setConfig({
    collapseDiv: "BEFORE_FETCH",
  })
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// when the page is loaded, before ads are requested.

var slot2 = googletag
  .defineSlot("/1234567/sports", [160, 600], "div-2")
  .setConfig({
    collapseDiv: "ON_NO_FILL",
  })
  .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

const slot1 = googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setConfig({
    collapseDiv: "BEFORE_FETCH",
  })
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// when the page is loaded, before ads are requested.

const slot2 = googletag
  .defineSlot("/1234567/sports", [160, 600], "div-2")!
  .setConfig({
    collapseDiv: "ON_NO_FILL",
  })
  .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ị trí quảng cáo trống
• Giảm thiểu sự thay đổi bố cục

Thông số
collapse: boolean	Có thu gọn vị trí 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ị trí ngay cả trước khi tìm nạp quảng cáo hay không. Bị bỏ qua nếu thu gọn không phải là true.

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

---

setConfig

setConfig(slotConfig: SlotSettingsConfig): Slot

Đặt các lựa chọn cấu hình chung cho vùng quảng cáo này.

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

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

---

setForceSafeFrame

setForceSafeFrame(forceSafeFrame: boolean): Slot

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

Vui lòng lưu ý những điều sau 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.
• Chế độ cài đặt cấp vị trí, nếu được chỉ định, 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), thì 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 được thực hiện trong giao diện người dùng Google Ad Manager.
• Tuy nhiên, nếu bạn đặt thành false hoặc không chỉ định, thì quảng cáo sẽ 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 trong giao diện người dùng Google Ad Manager.
• Bạn nên thận trọng khi sử dụng API này 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 mẫu quảng cáo được hiển thị trực tiếp trên trang của nhà xuất bản.

Không dùng nữa: Hãy sử dụng SlotSettingsConfig.safeFrame để thay thế.

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 phải hiển thị trong SafeFrame và false để chọn không tham gia 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 điều gì.

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

---

setSafeFrameConfig

setSafeFrameConfig(config: SafeFrameConfig): Slot

Đặt 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 vùng quảng cáo mà phương thức được gọi.

---

setTargeting

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

Đặt tham số nhắm mục tiêu tùy chỉnh cho vùng quảng cáo 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 tại đây sẽ ghi đè các tham 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: Thay vào đó, hãy sử dụng SlotSettingsConfig.targeting.

Ví dụ

JavaScript

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

// Example with a single value for a key.
slot.setConfig({
  targeting: {
    allow_expandable: "true",
  },
});

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

JavaScript (cũ)

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

// Example with a single value for a key.
slot.setConfig({
  targeting: {
    allow_expandable: "true",
  },
});

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

TypeScript

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

// Example with a single value for a key.
slot.setConfig({
  targeting: {
    allow_expandable: "true",
  },
});

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

Xem thêm

• Nhắm mục tiêu theo 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 vùng quảng cáo 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 tùy chỉnh cho vùng quảng cáo này, từ bản đồ khoá-giá trị trong đối tượng JSON. Thao tác này giống 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 đè, chỉ giá trị gần đây nhất được giữ lại.
• 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 tại đây sẽ ghi đè các tham 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 thông số nhắm mục tiêu.

Giá trị trả về
Slot	Đối tượng vùng quảng cáo 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 tăng kích thước quảng cáo.
AdSenseAttributesConfig	Chế độ cài đặt để kiểm soát hành vi của quảng cáo AdSense.
AutoRefreshConfig	Chế độ cài đặt cấu hình tự động làm mới.
ContinueButtonConfig	Chế độ cài đặt để định cấu hình hành vi của nút tiếp tục.
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	Chế độ cài đặt để kiểm soát việc sử dụng tính năng tải chậm trong GPT.
PageSettingsConfig	Giao diện cấu hình chính cho chế độ cài đặt cấp trang.
PrivacyTreatmentsConfig	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	Chế độ cài đặt để kiểm soát SafeFrame trong GPT.
SlotSettingsConfig	Giao diện cấu hình chính cho chế độ cài đặt cấp vị trí.
TaxonomyData	Một đối tượng chứa các giá trị cho một Taxonomy (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 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	Các 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 vị trí quảng cáo.

Xem thêm

• PageSettingsConfig.collapseDiv
• SlotSettingsConfig.collapseDiv

---

InterstitialTrigger

InterstitialTrigger: "unhideWindow" | "navBar" | "inactivity" | "endOfArticle" | "continueReading" | "backward"

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

Lưu ý: Kể từ ngày 15 tháng 6 năm 2026, điều kiện kích hoạt backward sẽ không còn được hỗ trợ và việc bật điều kiện này sẽ không có hiệu lực. Hãy xem ghi chú phát hành của GPT để biết thêm thông tin.

---

PrivacyTreatment

PrivacyTreatment: "disablePersonalization"

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

---

Cách phân loại

Taxonomy: "IAB_AUDIENCE_1_1" | "IAB_CONTENT_2_2"

Các 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 tăng kích thước quảng cáo.

Thuộc tính
enabled?	Liệu tính năng tăng kích thước 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

Liệu tính năng tăng kích thước quảng cáo có được bật hay không.

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ể sử dụng các thuộc tính này để ghi đè chế độ cài đặt phía máy chủ trên cơ sở mỗi yêu cầu.

Thuộc tính
adsense_ad_format?	Định dạng quảng cáo AdSense.
adsense_channel_ids?	Mã nhận dạng 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 nơi quảng cáo được hiển thị.
page_url?	URL của trang nơi 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ã nhận dạng kênh AdSense.

Các giá trị được cho phép là mã nhận dạng 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"

Cho biết 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ùng để thử nghiệm và sẽ không được tính vào số lượt hiển thị hoặc thanh toán. Bạn không được đặt chế độ cài đặt này cho lưu lượng truy cập thực tế, 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 hiển thị quảng cáo.

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 hiển thị quảng cáo.

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

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

---

googletag.config.AutoRefreshConfig

Chế độ cài đặt cấu hình tự động làm mới.

Thuộc tính
backForwardCache?	Liệu GPT có tự động làm mới một vị trí quảng cáo đang được xem khi trang được khôi phục từ bộ nhớ đệm cho thao tác tiến/lùi hay không.
heavyAds?	Liệu GPT có tự động làm mới một vị trí quảng cáo hay không nếu biện pháp can thiệp đối với quảng cáo nặng của Chrome kích hoạt trên iframe quảng cáo của vị trí đó.

Thuộc tính

---

Optional backForwardCache

backForwardCache?: boolean

Liệu GPT có tự động làm mới một vị trí quảng cáo đang được xem khi trang được khôi phục từ bộ nhớ đệm cho thao tác tiến/lùi hay không. Mặc định là true.

Ví dụ

JavaScript

// Set the auto refresh configuration, disabling auto refresh on
// back/forward cache restore.
googletag.setConfig({ autoRefresh: { backForwardCache: false } });

// Clear the auto refresh configuration, restoring to default behavior.
googletag.setConfig({ autoRefresh: null });

JavaScript (cũ)

// Set the auto refresh configuration, disabling auto refresh on
// back/forward cache restore.
googletag.setConfig({ autoRefresh: { backForwardCache: false } });

// Clear the auto refresh configuration, restoring to default behavior.
googletag.setConfig({ autoRefresh: null });

TypeScript

// Set the auto refresh configuration, disabling auto refresh on
// back/forward cache restore.
googletag.setConfig({ autoRefresh: { backForwardCache: false } });

// Clear the auto refresh configuration, restoring to default behavior.
googletag.setConfig({ autoRefresh: null });

Xem thêm

• Bộ nhớ đệm cho thao tác tiến/lùi

---

Optional heavyAds

heavyAds?: boolean

Liệu GPT có tự động làm mới một vị trí quảng cáo hay không nếu biện pháp can thiệp đối với quảng cáo nặng của Chrome kích hoạt trên iframe quảng cáo của vị trí đó. Mặc định là true.

Ví dụ

JavaScript

// Set the auto refresh configuration, disabling auto refresh on heavy
// ad intervention.
googletag.setConfig({ autoRefresh: { heavyAds: false } });

// Clear the auto refresh configuration, restoring to default behavior.
googletag.setConfig({ autoRefresh: null });

JavaScript (cũ)

// Set the auto refresh configuration, disabling auto refresh on heavy
// ad intervention.
googletag.setConfig({ autoRefresh: { heavyAds: false } });

// Clear the auto refresh configuration, restoring to default behavior.
googletag.setConfig({ autoRefresh: null });

TypeScript

// Set the auto refresh configuration, disabling auto refresh on heavy
// ad intervention.
googletag.setConfig({ autoRefresh: { heavyAds: false } });

// Clear the auto refresh configuration, restoring to default behavior.
googletag.setConfig({ autoRefresh: null });

Xem thêm

• Tìm hiểu về biện pháp can thiệp đối với quảng cáo nặng của Chrome

---

googletag.config.ContinueButtonConfig

Chế độ cài đặt để định cấu hình hành vi của nút tiếp tục.

Thuộc tính
backgroundColor?	Màu nền của nút.
font?	Bộ phông chữ của văn bản trên nút.
fontColor?	Màu văn bản của nút.
freqCapIntervalMinutes?	Khoảng thời gian giới hạn tần suất, tính bằng phút.
targetId?	Mã nhận dạng của phần tử HTML để hiển thị/kích hoạt nút tiếp tục.

Xem thêm

• SlotSettingsConfig.continueButton

Thuộc tính

---

Optional backgroundColor

backgroundColor?: string

Màu nền của nút.

Ví dụ: 'blue', '#94B1FF'

---

Optional phông chữ

font?: string

Bộ phông chữ của văn bản trên nút.

Ví dụ: 'Arial'

---

Optional fontColor

fontColor?: string

Màu văn bản của nút.

Ví dụ: 'white', '#B73B87'

---

Optional freqCapIntervalMinutes

freqCapIntervalMinutes?: number

Khoảng thời gian giới hạn tần suất tính bằng phút.

Phải là số nguyên lớn hơn hoặc bằng 1.

---

Optional targetId

targetId?: string

Mã nhận dạng của phần tử HTML để hiển thị/kích hoạt nút tiếp tụ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 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

Liệu có cần sự đồng ý cho phép truy cập vào 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 quảng cáo xen kẽ chỉ hiển thị cho những người dùng đã đồng ý cho phép 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

• Thiết lập và chạy quảng cáo xen kẽ trên web

---

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.

Nếu bạn đặt giá trị của điều kiện kích hoạt quảng cáo xen kẽ thành true, thì điều kiện kích hoạt này sẽ được bật, còn nếu bạn đặt thành false, thì điều kiện kích hoạt này sẽ bị 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

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

Thuộc tính
fetchMarginPercent?	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 yêu cầu quảng cáo, được biểu thị dưới dạng tỷ lệ phần trăm kích thước khung nhìn.
mobileScaling?	Hệ số nhân á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ị dưới dạ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 nhìn 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ị dưới dạng tỷ lệ phần trăm kích thước khung nhìn.

Khi được sử dụng cùng 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í quảng cáo xuất hiện trong khung nhìn", 100 có nghĩa là "khi quảng cáo cách khung nhìn 1 khung nhìn", v.v.

---

Optional mobileScaling

mobileScaling?: number

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

Đ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, nơi 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ả lề với 2 trên thiết bị di động, tăng khoảng cách tối thiểu mà một vị trí có thể cách khung nhìn 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 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ị dưới dạng tỷ lệ phần trăm kích thước khung nhìn.

Khi được sử 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í quảng cáo xuất hiện trong khung nhìn", 100 có nghĩa là "khi quảng cáo cách khung nhìn 1 khung nhìn", 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ả 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 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ả chế độ cài đặt cho một tính năng nhất định đều được cập nhật mỗi khi gọi 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 tăng kích thước 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.
autoRefresh?	Chế độ cài đặt để định cấu hình hành vi tự động làm mới quảng cáo.
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 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?	Chế độ cài đặt để kiểm soát việc sử dụng tính năng tải chậm trong GPT.
location?	Chế độ cài đặt để nhắm mục tiêu theo vị trí địa lý cho các mục hàng.
pps?	Chế độ cài đặt để kiểm soát tín hiệu do nhà xuất bản cung cấp (PPS).
privacyTreatments?	Chế độ cài đặt để kiểm soát cách xử lý quyền riêng tư của nhà xuất bản.
requestHookTimeoutMs?	Chế độ cài đặt để kiểm soát thời gian tối đa mà GPT sẽ đợi tất cả các hook yêu cầu đã đăng ký hoàn tất trước khi tiếp tục gửi yêu cầu quảng cáo.
safeFrame?	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 theo khoá-giá trị.
threadYield?	Chế độ cài đặt để kiểm soát xem 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 tăng kích thước 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ả vị trí 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 yêu cầu quảng cáo 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: Hãy sử dụng threadYield. Tính năng này sẽ sớm bị xoá.

---

Optional autoRefresh

autoRefresh?: AutoRefreshConfig

Chế độ cài đặt để định cấu hình hành vi tự động làm mới quảng cáo.

Ví dụ

JavaScript

// Set the auto refresh configuration.
googletag.setConfig({ autoRefresh: { heavyAds: false } });

// Clear the auto refresh configuration.
googletag.setConfig({ autoRefresh: null });

JavaScript (cũ)

// Set the auto refresh configuration.
googletag.setConfig({ autoRefresh: { heavyAds: false } });

// Clear the auto refresh configuration.
googletag.setConfig({ autoRefresh: null });

TypeScript

// Set the auto refresh configuration.
googletag.setConfig({ autoRefresh: { heavyAds: false } });

// Clear the auto refresh configuration.
googletag.setConfig({ autoRefresh: null });

---

Optional categoryExclusion

categoryExclusion?: string[]

Chế độ cài đặt để định cấu hình tiêu chí 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 yêu cầu quảng cáo được thực hiện 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 vị trí quảng cáo.

Vị trí quảng cáo thu gọn không chiếm bất kỳ không gian 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ị trí quảng cáo sẽ không thu gọn, cho dù có quảng cáo được trả về hay không.
• BEFORE_FETCH: Vị trí 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ị trí quảng cáo sẽ bắt đầu 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ị trí quảng cáo trống
• Giảm thiểu sự 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ý 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 hành động 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, hệ thống sẽ không yêu cầu quảng cáo cho các vùng quảng cáo đã đă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 đến PubAdsService.refresh để bắt đầu 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 phân lô SRA

---

Optional lazyLoad

lazyLoad?: LazyLoadConfig

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

Tải chậm 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 xuất hiện trong khung nhìn của người dùng. Để xem ví dụ chi tiết hơn, hãy xem mẫu Tải chậm.

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

Mọi chế độ cài đặt tải chậm không được chỉ định khi gọi setConfig() sẽ sử dụng giá trị mặc định do Google đặt. Các chế độ 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 chậm

---

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

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 Experimental requestHookTimeoutMs

requestHookTimeoutMs?: number | "auto"

Chế độ cài đặt để kiểm soát thời gian tối đa mà GPT sẽ đợi tất cả các hook yêu cầu đã đăng ký hoàn tất trước khi tiếp tục yêu cầu quảng cáo.

Tất cả các hook yêu cầu đã đăng ký đều được thực thi song song. Thời gian chờ này xác định giới hạn trên về thời gian tạm dừng quy trình yêu cầu quảng cáo trong khi chờ các quá trình thực thi song song đó hoàn tất.

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

• Số dương tính bằng mili giây: Thời gian chờ tuỳ chỉnh.
• 'auto': GPT sử dụng thời gian chờ do Google tối ưu hoá.
• null: Tắt thời gian chờ (GPT chờ vô thời hạn để các hook hoàn tất).

Ví dụ

JavaScript

// Set a 1000ms timeout for request hooks.
googletag.setConfig({ requestHookTimeoutMs: 1000 });

// Use a Google-optimized timeout for request hooks.
googletag.setConfig({ requestHookTimeoutMs: "auto" });

// Clear the timeout.
googletag.setConfig({ requestHookTimeoutMs: null });

JavaScript (cũ)

// Set a 1000ms timeout for request hooks.
googletag.setConfig({ requestHookTimeoutMs: 1000 });

// Use a Google-optimized timeout for request hooks.
googletag.setConfig({ requestHookTimeoutMs: "auto" });

// Clear the timeout.
googletag.setConfig({ requestHookTimeoutMs: null });

TypeScript

// Set a 1000ms timeout for request hooks.
googletag.setConfig({ requestHookTimeoutMs: 1000 });

// Use a Google-optimized timeout for request hooks.
googletag.setConfig({ requestHookTimeoutMs: "auto" });

// Clear the timeout.
googletag.setConfig({ requestHookTimeoutMs: null });

---

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ả vị trí quảng cáo trên trang. Các vị trí quảng cáo riêng lẻ có thể ghi đè các 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 bạn bật SRA, tất cả vị trí quảng cáo được xác định trước 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 quảng cáo khoanh vùng và loại trừ cạnh tranh được thực hiện.

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.

Phương thức này phải được gọi 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ề khoanh vùng quảng cáo
• Các phương pháp hay nhất về quảng cáo: Sử dụng đúng cách Cấu trúc yêu cầu duy nhất
• Kiểm soát việc phân 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 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ẽ áp dụng cho tất cả vị trí 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 theo khoá-giá trị

---

Optional threadYield

threadYield?: "DISABLED" | "ENABLED_ALL_SLOTS"

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

GPT sẽ chỉ nhường 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 nhìn.
• ENABLED_ALL_SLOTS: GPT sẽ nhường luồng JS cho tất cả vị trí bất kể vị trí đó có nằm trong khung nhìn hay không.
• DISABLED: GPT sẽ không tạo 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 biểu

---

Optional videoAds

videoAds?: VideoAdsConfig

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

• Phân tích nội dung video

---

googletag.config.PrivacyTreatmentsConfig

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 loạt cách nhà xuất bản xử lý quyền riêng tư để 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 mối liên kết Hệ thống 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 mối liên kết Hệ thống phân loại hoặc giá trị rỗng để xoá cấu hình.

---

googletag.config.SafeFrameConfig

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

Thuộc tính
allowOverlayExpansion?	Liệu SafeFrame có nên cho phép nội dung quảng cáo mở rộng bằng cách phủ lên 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?	Liệu(các) quảng cáo có bắt buộc phải hiển thị bằng vùng chứa SafeFrame hay không.
sandbox?	Liệu SafeFrame có nên sử dụng thuộc tính hộp cát HTML5 để ngăn chặn hoạt động điều hướng cấp cao nhất mà không có hoạt động tương tác của người dùng hay không.
useUniqueDomain?	Không dùng nữa. Liệu SafeFrame có nên sử dụng miền con 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ó nên cho phép nội dung quảng cáo mở rộng bằng cách phủ lên 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

Liệu(các) quảng cáo có bắt buộc phải hiển thị bằng vùng chứa SafeFrame hay không.

---

Optional hộp cát

sandbox?: boolean

Liệu SafeFrame có nên sử dụng thuộc tính hộp cát HTML5 để ngăn chặn việc đ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ẽ tắt các trình bổ trợ (ví dụ: Flash).

---

Optional useUniqueDomain

useUniqueDomain?: boolean

Liệu SafeFrame có nên sử dụng miền con 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ùng quảng cáo.

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ùng quảng cáo.

Tất 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 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 đều được cập nhật mỗi khi gọi 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 tăng kích thước 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.
continueButton?	Chế độ cài đặt để định cấu hình hành vi của nút tiếp tục cho quảng cáo trong lúc tạm dừng nội dung.
interstitial?	Chế độ cài đặt giúp định cấu hình hành vi của vị trí quảng cáo xen kẽ.
safeFrame?	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 theo khoá-giá trị.

Thuộc tính

---

Optional adExpansion

adExpansion?: AdExpansionConfig

Chế độ cài đặt để định cấu hình tính năng tăng kích thước quảng cáo.

Xem thêm

• Tăng kích thước 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 yêu cầu quảng cáo 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 tiêu chí 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.

Máy chủ Google Ad Manager vẫn ghi lại một lượt nhấp ngay cả khi URL nhấp được thay thế. Mọi URL trang đích 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ị đã cung cấp. Nếu bạn đặt giá trị này nhiều lần, thì giá trị mới sẽ ghi đè mọi giá trị đã định cấu hình trước đó. 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ị trí quảng cáo.

Vị trí quảng cáo thu gọn không chiếm không gian 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ị trí quảng cáo sẽ không thu gọn, cho dù có quảng cáo được trả về hay không.
• BEFORE_FETCH: Vị trí 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ị trí quảng cáo sẽ bắt đầu 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ị trí quảng cáo trống
• Giảm thiểu sự thay đổi bố cục

---

Optional continueButton

continueButton?: ContinueButtonConfig

Chế độ cài đặt để định cấu hình hành vi của nút tiếp tục cho quảng cáo trong lúc tạm dừng nội dung.

Các chế độ cài đặt này cho phép tuỳ chỉnh giao diện và hành vi của các hoạt động tương tác thoát và tiếp tục đọc liên quan đến định dạng tạm dừng nội dung.

Mọi chế độ cài đặt nút tiếp tục không được chỉ định khi gọi setConfig() sẽ sử dụng giá trị mặc định do Google đặt.

Để tắt hoặc xoá tất cả chế độ cài đặt nút tiếp tục, hãy truyền null.

Ví dụ

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());
// Configure continue button settings.
slot.setConfig({
  continueButton: {
    font: "Arial",
    fontColor: "white",
    backgroundColor: "blue",
    targetId: "target-div-id",
    freqCapIntervalMinutes: 20,
  },
});

// Clear continue button settings.
slot.setConfig({ continueButton: null });

JavaScript (cũ)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());
// Configure continue button settings.
slot.setConfig({
  continueButton: {
    font: "Arial",
    fontColor: "white",
    backgroundColor: "blue",
    targetId: "target-div-id",
    freqCapIntervalMinutes: 20,
  },
});

// Clear continue button settings.
slot.setConfig({ continueButton: null });

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());
// Configure continue button settings.
slot.setConfig({
  continueButton: {
    font: "Arial",
    fontColor: "white",
    backgroundColor: "blue",
    targetId: "target-div-id",
    freqCapIntervalMinutes: 20,
  },
});

// Clear continue button settings.
slot.setConfig({ continueButton: null });

---

Optional quảng cáo xen kẽ

interstitial?: InterstitialConfig

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

Xem thêm

• Thiết lập và chạy quảng cáo xen kẽ trên web

---

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ị trí 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ị 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 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 theo khoá-giá trị

---

googletag.config.TaxonomyData

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

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ã Content ID của nội dung video.

Xem thêm

• PageSettingsConfig.videoAds

Thuộc tính

---

enableVideoAds

enableVideoAds: boolean

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

Khi được đặt thành true, giá trị này sẽ bật các quy tắc ràng buộc về việc 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 bạn biết nội dung video, hãy đặt videoContentId và videoCmsId thành các giá trị được cung cấp cho dịch vụ phân tích 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à giá trị duy nhất do dịch vụ phân tích 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

Content ID của video.

Đây là một giá trị riêng biệt giúp 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 gán.

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ợ.
TagForAgeTreatment	Chế độ cài đặt xử lý theo độ tuổi đượ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 được GPT hỗ trợ.

Xem thêm

• defineOutOfPageSlot

Thành viên của bảng liệt kê
AD_INTENTS	Định dạng quảng cáo dựa trên ý định.
BOTTOM_ANCHOR	Định dạng quảng cáo cố định, trong đó vị trí quảng cáo nằm ở 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à đị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 quảng cáo 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 nằm ở đầu khung nhìn.

---

TagForAgeTreatment

TagForAgeTreatment

Chế độ cài đặt xử lý theo độ tuổi được GPT hỗ trợ.

Xem thêm

• PrivacySettingsConfig.tagForAgeTreatment

Thành viên của bảng liệt kê
CHILD	Cho biết rằng các yêu cầu quảng cáo phải áp dụng chế độ xử lý theo độ tuổi của TRẺ EM.
TEEN	Cho biết rằng các yêu cầu quảng cáo phải áp dụng chế độ xử lý theo độ tuổi của THANH THIẾU NIÊN.
UNSPECIFIED	Giá trị mặc định. Cho biết rằng không có tín hiệu xử lý bị giới hạn độ tuổi cụ thể nào áp dụng cho yêu cầu quảng cáo.

---

TrafficSource

TrafficSource

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

Xem thêm

• PrivacySettingsConfig.trafficSource

Thành viên của bảng liệt kê
ORGANIC	Lượt nhập URL trực tiếp, lượt tìm kiếm trên 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 sử 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ả sự kiện GPT.
EventTypeMap	Đây là một loại giả 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ẽ thủ công trong 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 Active View.
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 nhận được phần thưởng sau khi 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 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ùng quảng cáo.
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 nhận được phản hồi quảng cáo cho một vùng quảng cáo cụ thể.
SlotVisibilityChangedEvent	Sự kiện này được kích hoạt bất cứ khi nào tỷ lệ phần trăm trên màn hình của một vị trí quảng cáo thay đổi.

---

googletag.events.Event

Giao diện cơ sở cho tất cả sự kiện GPT. Tất cả sự kiện GPT dưới đây 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.

---

vị trí

slot: Slot

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

---

googletag.events.EventTypeMap

Đây là một loại giả 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. Lớp này được ghi lại chỉ nhằm mục đích tham khảo và đảm bảo an toàn về kiểu.

Thuộc tính
gameManualInterstitialSlotClosed	Bí danh cho events.GameManualInterstitialSlotClosedEvent.
gameManualInterstitialSlotReady	Bí danh cho events.GameManualInterstitialSlotReadyEvent.
impressionViewable	Bí danh cho events.ImpressionViewableEvent.
rewardedSlotClosed	Bí danh 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	Bí danh cho events.SlotRenderEndedEvent.
slotRequested	Bí danh cho events.SlotRequestedEvent.
slotResponseReceived	Bí danh cho events.SlotResponseReceived.
slotVisibilityChanged	Bí danh cho events.SlotVisibilityChangedEvent.

Thuộc tính

---

gameManualInterstitialSlotClosed

gameManualInterstitialSlotClosed: GameManualInterstitialSlotClosedEvent

Bí danh cho events.GameManualInterstitialSlotClosedEvent.

---

gameManualInterstitialSlotReady

gameManualInterstitialSlotReady: GameManualInterstitialSlotReadyEvent

Bí danh cho events.GameManualInterstitialSlotReadyEvent.

---

impressionViewable

impressionViewable: ImpressionViewableEvent

Bí danh cho events.ImpressionViewableEvent.

---

rewardedSlotClosed

rewardedSlotClosed: RewardedSlotClosedEvent

Bí danh 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

Bí danh cho events.SlotRenderEndedEvent.

---

slotRequested

slotRequested: SlotRequestedEvent

Bí danh cho events.SlotRequestedEvent.

---

slotResponseReceived

slotResponseReceived: SlotResponseReceived

Bí danh cho events.SlotResponseReceived.

---

slotVisibilityChanged

slotVisibilityChanged: SlotVisibilityChangedEvent

Bí danh cho events.SlotVisibilityChangedEvent.

---

googletag.events.GameManualInterstitialSlotClosedEvent

Kéo dài 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 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. Được kế thừa từ tài sản Event.serviceName
slot	Vị trí đã kích hoạt sự kiện. Được kế thừa từ tài sản 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

Kéo dài Event

Sự kiện này được kích hoạt khi một vị trí 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. Được kế thừa từ tài sản Event.serviceName
slot	Vị trí đã kích hoạt sự kiện. Được kế thừa từ tài sản 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(): boolean

Hiển thị quảng cáo xen kẽ thủ công trong trò chơi cho người dùng. Trả về thông tin cho biết quảng cáo có được hiển thị thành công hay không.

Giá trị trả về
boolean

---

googletag.events.ImpressionViewableEvent

Kéo dài 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 Active View.

Thuộc tính
serviceName	Tên của dịch vụ đã kích hoạt sự kiện. Được kế thừa từ tài sản Event.serviceName
slot	Vị trí đã kích hoạt sự kiện. Được kế thừa từ tài sản 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

Kéo dài 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 cấp. Để xác định xem phần thưởng đã được cấp hay chưa, hãy sử dụng events.RewardedSlotGrantedEvent.

Thuộc tính
serviceName	Tên của dịch vụ đã kích hoạt sự kiện. Được kế thừa từ tài sản Event.serviceName
slot	Vị trí đã kích hoạt sự kiện. Được kế thừa từ tài sản 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

Kéo dài Event

Sự kiện này được kích hoạt khi người dùng nhận được phần thưởng sau khi 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í để nhận 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 cấp.
serviceName	Tên của dịch vụ đã kích hoạt sự kiện. Được kế thừa từ tài sản Event.serviceName
slot	Vị trí đã kích hoạt sự kiện. Được kế thừa từ tài sản 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

---

payload

payload: RewardedPayload

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

---

googletag.events.RewardedSlotReadyEvent

Kéo dài 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. Được kế thừa từ tài sản Event.serviceName
slot	Vị trí đã kích hoạt sự kiện. Được kế thừa từ tài sản 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(): boolean

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.

Giá trị trả về
boolean	Liệu quảng cáo có tặng thưởng có được hiển thị thành công hay không.

---

googletag.events.RewardedSlotVideoCompletedEvent

Kéo dài Event

Sự kiện này được kích hoạt khi 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. Được kế thừa từ tài sản Event.serviceName
slot	Vị trí đã kích hoạt sự kiện. Được kế thừa từ tài sản 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

Kéo dài 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 truyền thông ở chế độ hiển thị đồng bộ, không có iframe nào được sử 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. Được kế thừa từ tài sản Event.serviceName
slot	Vị trí đã kích hoạt sự kiện. Được kế thừa từ tài sản 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

Kéo dài 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ùng quảng cáo. Sự kiện này sẽ xảy ra trước khi 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 hiển thị. 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 các 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 trước được hiển thị.
creativeTemplateId	Mã mẫu của 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 lấp đầy hay không.
isEmpty	Liệu quảng cáo có được trả về cho vị trí quảng cáo 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 riêng biệt của lượt phản hồi quảng cáo.
serviceName	Tên của dịch vụ đã kích hoạt sự kiện. Được kế thừa từ tài sản Event.serviceName
size	Cho biết kích thước pixel của mẫu quảng cáo được hiển thị.
slot	Vị trí đã kích hoạt sự kiện. Được kế thừa từ tài sản Event.slot
slotContentChanged	Liệu nội dung vị trí có thay đổi theo 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 đặt trước hoặc quảng cáo thay thế được hiển thị.
sourceAgnosticLineItemId	Mã mục hàng của quảng cáo đặt trước hoặc quảng cáo thay thế được hiển thị.
yieldGroupIds	Mã 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ị trí 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ị trí 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 các công ty đặt giá thầu cho quảng cáo thay thế được hiển thị. Giá trị là null cho 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 trước được hiển thị. Giá trị là null đối với các vị trí 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 của 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ị trí 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 lấp đầy hay không. Giá trị là true nếu quảng cáo là quảng cáo thay thế, nếu không thì giá trị là false.

---

isEmpty

isEmpty: boolean

Liệu quảng cáo có được trả về cho vị trí quảng cáo 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ị trí 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 riêng biệt của lượt 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 pixel của mẫu quảng cáo được hiển thị. Ví dụ: [728, 90] Giá trị là null cho các vị trí quảng cáo trống.

---

slotContentChanged

slotContentChanged: boolean

Liệu nội dung vị trí có thay đổi theo quảng cáo được hiển thị hay không. Giá trị là true nếu nội dung đã thay đổi, nếu không thì giá trị là false.

---

sourceAgnosticCreativeId

sourceAgnosticCreativeId: number

Mã mẫu quảng cáo của quảng cáo đặt trước hoặc quảng cáo thay thế đượ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ằng các dịch vụ không phải PubAdsService.

---

sourceAgnosticLineItemId

sourceAgnosticLineItemId: number

Mã mục hàng của quảng cáo đặt trước hoặc quảng cáo thay thế đượ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ằng các dịch vụ không phải PubAdsService.

---

yieldGroupIds

yieldGroupIds: number[]

Mã 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 cho 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

Kéo dài 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. Được kế thừa từ tài sản Event.serviceName
slot	Vị trí đã kích hoạt sự kiện. Được kế thừa từ tài sản 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

Kéo dài Event

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

Thuộc tính
serviceName	Tên của dịch vụ đã kích hoạt sự kiện. Được kế thừa từ tài sản Event.serviceName
slot	Vị trí đã kích hoạt sự kiện. Được kế thừa từ tài sản 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

Kéo dài Event

Sự kiện này được kích hoạt bất cứ khi nào tỷ lệ phần trăm trên màn hình của một vị trí quảng cáo thay đổi. Sự kiện này được điều tiết và sẽ không kích hoạt thường xuyên hơn một lần 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. Được kế thừa từ tài sản Event.serviceName
slot	Vị trí đã kích hoạt sự kiện. Được kế thừa từ tài sản 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 sử 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	Giao diện để quản lý tín hiệu an toàn.

Bí danh loại
SecureSignalProvider	Giao diện để trả về 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ề 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 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. Hàm thu thập, trả về một Promise phân giải thành tín hiệu an toàn.
2. id xác định bên đặt giá thầu 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 tín hiệu an toàn.
id	Giá trị nhận dạng riêng biệt cho 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 tín hiệu an toàn.

---

id

id: string

Giá trị nhận dạng riêng biệt cho 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. Hàm thu thập, trả về một Promise phân giải thành tín hiệu an toàn.
2. networkCode xác định nhà xuất bản liên kết với tín hiệu.

Để trả về tín hiệu an toàn cho một 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 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 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 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 liên kết với tín hiệu an toàn này.

---

googletag.secureSignals.SecureSignalProvidersArray

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 tất cả trình thu thậ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 quá 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ả 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 quá trình tạo tín hiệu.

Thông số
provider: SecureSignalProvider	Đối tượng secureSignals.SecureSignalProvider cần thêm vào mảng.