Giúp cải thiện trải nghiệm cho nhà phát triển Thẻ nhà xuất bản của Google bằng cách chia sẻ ý kiến của bạn trong Bài khảo sát dành cho nhà phát triển về Thẻ nhà xuất bản của Google năm 2024.

Trang này được dịch bởi Cloud Translation API.

Tài liệu tham khảo GPT

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

Biểu thức kiểu
`string`	Loại chuỗi nguyên thuỷ.
`string[]`	Loại mảng, trong đó giá trị chỉ có thể là chuỗi.
`number \| string`	Loại hợp nhất, trong đó giá trị có thể là số hoặc chuỗi.
`Array<number \| string>`	Loại mảng, trong đó các giá trị là loại phức tạp (hợp nhất).
`[number, string]`	Loại 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`	Kiểu hàm không có đối số được xác định và không có giá trị trả về.

Để tìm hiểu thêm về các loại và biểu thức loại được hỗ trợ, hãy tham khảo Hướng dẫn TypeScript .

Chú thích kiểu

Dấu hai chấm sau biến, tên tham số, tên thuộc tính hoặc chữ ký hàm biểu thị chú giải loại. Chú thích loại mô tả các loại 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 trình bày ví dụ về các chú giải loại mà bạn có thể thấy trong tài liệu tham khảo này.

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

googletag

Không gian tên toàn cục 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ý các tín hiệu an toàn.

Giao diện
`CommandArray`	Mảng lệnh chấp nhận một trình tự 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.
`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 được liên kết với một quảng cáo có tặng thưởng.
`SafeFrameConfig`	Đối tượng cấu hình cho vùng chứa SafeFrame.
`Service`	Lớp dịch vụ cơ sở chứa các phương thức phổ biến cho tất cả dịch vụ.
`SizeMappingBuilder`	Trình tạo cho các đối tượng quy cách á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.

Nhập bí danh
`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 khung có thể có.
`SingleSize`	Một kích thước hợp lệ 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 ánh xạ kích thước.

Biến
`apiReady`	Cờ cho biết API GPT đã được tải và sẵn sàng được gọi.
`cmd`	Tham chiếu đến hàng đợi lệnh toàn cục để 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ề tham chiếu đến CompanionAdsService.
`defineOutOfPageSlot`	Tạo vùng quảng cáo ngoài trang có đường dẫn đơn vị quảng cáo nhất định.
`defineSlot`	Tạo một vùng quảng cáo có đường dẫn và kích thước đơn vị quảng cáo nhất định, đồng thời liên kết vùng quảng cáo đó với mã nhận dạng của một phần tử div trên trang sẽ chứa quảng cáo.
`destroySlots`	Huỷ các vùng đã cho, xoá tất cả các đối tượng và tệp tham chiếu liên quan của các vùng đó khỏi GPT.
`disablePublisherConsole`	Tắt Bảng điều khiển dành cho nhà xuất bản của Google.
`display`	Hướng dẫn các dịch vụ khe hiển thị khe.
`enableServices`	Bật tất cả các dịch vụ GPT đã được xác định cho vùng quảng cáo trên trang.
`getVersion`	Trả về phiên bản GPT hiện tại.
`openConsole`	Mở Bảng điều khiển dành cho nhà xuất bản của Google.
`pubads`	Trả về tham chiếu đến PubAdsService.
`setAdIframeTitle`	Đặt tiêu đề cho tất cả iframe vùng chứa quảng cáo do PubAdsService tạo, kể từ thời điểm này.
`setConfig`	Đặt các tuỳ chọn cấu hình chung cho trang.
`sizeMapping`	Tạo một SizeMappingBuilder mới.

Loại bí danh

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: "fluid" | ["fluid"]

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

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

SingleSize

SingleSize: SingleSizeArray | NamedSize

Một kích thước hợp lệ 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. Dùng cho quảng cáo thích ứng.

SizeMappingArray

SizeMappingArray: SizeMapping[]

Danh sách ánh xạ kích thước.

Biến

`Const` apiReady

apiReady: boolean | undefined

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

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

`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 tới một mảng JavaScript trống bằng cú pháp thẻ GPT trên trang và cmd.push là phương thức Array.push tiêu chuẩn để thêm một phần tử vào cuối mảng. Khi GPT JavaScript được tải, GPT JavaScript xem qua mảng và thực thi tất cả hàm theo thứ tự. Sau đó, tập lệnh sẽ thay thế cmd bằng đối tượng CommandArray có phương thức đẩy được xác định để thực thi đối số hàm được truyền vào đối tượng đó. Cơ chế này cho phép GPT giảm độ trễ nhận thấy được bằng cách tìm nạp JavaScript không đồng bộ trong khi vẫn 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 trình tự các hàm tạo tín hiệu và gọi các hàm đó theo thứ tự. Định dạng này nhằm thay thế một mảng chuẩn dùng để thêm các hàm tạo tín hiệu vào hàng đợi sẽ được gọi khi GPT được tải.

Ví dụ:

JavaScript

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

JavaScript (cũ)

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

TypeScript

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

Xem thêm

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

Hàm

companionAds

companionAds(): CompanionAdsService

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

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

defineOutOfPageSlot

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

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

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

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

Ví dụ:

JavaScript

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

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

JavaScript (cũ)

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

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

TypeScript

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

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

Xem thêm

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`	Khung giờ mới tạo hoặc `null` nếu không thể tạo khung giờ.

defineSlot

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

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

Ví dụ:

JavaScript

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

JavaScript (cũ)

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

TypeScript

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

Xem thêm

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

Thông số
`adUnitPath: string`	Đường dẫn đơ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 khe được 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`	Khung giờ mới tạo hoặc `null` nếu không thể tạo khung giờ.

destroySlots

destroySlots(slots?: Slot[]): boolean

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

Việc gọi API này trên một vùng 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 khe 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ị trí đó nếu trang nhà xuất bản duy trì tệp tham chiếu đến vị trí đó. Việc gọi API này sẽ giúp div được liên kết với vùng đó có thể sử dụng lại.

Cụ thể, việc huỷ một vùng sẽ xoá quảng cáo khỏi lượt xem trang tồn tại lâu dài 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 rào cản hoặc tiêu chí loại trừ cạnh tranh liên quan đến quảng cáo này. Việc không gọi hàm này trước khi xoá div của một khung khỏi trang sẽ dẫn đến hành vi không xác định.

Ví dụ:

JavaScript

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

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

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

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

JavaScript (cũ)

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

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

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

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

TypeScript

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

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

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

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

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

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

disablePublisherConsole

disablePublisherConsole(): void

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

Xem thêm

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

display

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

Hướng dẫn các dịch vụ khe hiển thị khe. Mỗi vùng quảng cáo chỉ được hiển thị một lần trên mỗi trang. Tất cả các khung giờ đều phải được xác định và có một dịch vụ liên kết với chúng trước khi hiển thị. Lệnh gọi hiển thị không được diễn ra cho đến khi phần tử có trong DOM. Cách thông thường để thực hiện việc này là đặt mã đó 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 bạn đang sử dụng cấu trúc yêu cầu duy nhất (SRA), thì tất cả các vùng quảng cáo chưa được tìm nạp tại thời điểm 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

Thông số
`divOrSlot: string \| Element \| Slot`	Mã của phần tử div chứa vị trí quảng cáo hoặc phần tử div hoặc đối tượng vị trí. Nếu bạn cung cấp 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ùng quảng cáo trên trang.

getVersion

getVersion(): string

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

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ùng quảng cáo. Giá trị này là không bắt buộc. Khi được cung cấp, Bảng điều khiển dành cho nhà xuất bản sẽ cố gắng mở với thông tin chi tiết về vị trí quảng cáo được chỉ định trong chế độ xem.

pubads

pubads(): PubAdsService

Trả về tham chiếu đến PubAdsService.

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

setAdIframeTitle

setAdIframeTitle(title: string): void

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

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 tuỳ chọn cấu hình chung cho trang.

Thông số
`config: PageSettingsConfig`

sizeMapping

sizeMapping(): SizeMappingBuilder

Tạo một SizeMappingBuilder mới.

Xem thêm

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

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

googletag.CommandArray

Mảng lệnh chấp nhận một trình tự hàm và gọi các hàm đó theo thứ tự. Mục đích của lớp này là thay thế một mảng chuẩn dùng để thêm các hàm vào hàng đợi để gọi sau khi tải GPT.

Phương thức
`push`	Thực thi trình tự các hàm được chỉ định trong đố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 đối số theo thứ tự.

Ví dụ:

JavaScript

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

JavaScript (cũ)

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

TypeScript

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

Thông số
`Rest ...f: ((this: typeof globalThis) => void)[]`	Một hàm JavaScript cần được thực thi. Liên kết thời gian chạy sẽ luôn là `globalThis`. Hãy cân nhắ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 kèm theo.

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

googletag.CompanionAdsService

Mở rộng Service

Dịch vụ Quảng cáo đồng hành. 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 hàm JavaScript khi một sự kiện GPT cụ thể xảy ra trên trang. Kế thừa từ `Service.addEventListener`
`getSlots`	Lấy danh sách các khung giờ được liên kết với dịch vụ này. Kế thừa từ `Service.getSlots`
`removeEventListener`	Xoá trình nghe đã đăng ký trước đó. Kế thừa từ `Service.removeEventListener`
`setRefreshUnfilledSlots`	Đặt xem các vị trí đồng hành chưa được lấp đầy có được tự động chèn lấp hay không.

Xem thêm

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

Phương thức

setRefreshUnfilledSlots

setRefreshUnfilledSlots(value: boolean): void

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

Phương thức này có thể được gọi nhiều lần trong vòng đời của trang để bật và tắt tính năng chèn lấp. Chỉ những vị trí 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ị trí đồng hành trống khi video trên Ad Exchange được phân phát.

Ví dụ:

JavaScript

googletag.companionAds().setRefreshUnfilledSlots(true);

JavaScript (cũ)

googletag.companionAds().setRefreshUnfilledSlots(true);

TypeScript

googletag.companionAds().setRefreshUnfilledSlots(true);

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

googletag.PrivacySettingsConfig

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

Thuộc tính
`childDirectedTreatment?`	Cho biết liệu trang có được xem là dành cho trẻ em hay không.
`limitedAds?`	Cho phép hoạt động phân phát chạy ở chế độ quảng cáo bị hạn chế để hỗ trợ nhà xuất bản đáp ứng các yêu cầu tuân thủ quy định.
`nonPersonalizedAds?`	Cho phép hoạt động phân phát chạy ở chế độ quảng cáo không được cá nhân hoá để hỗ trợ nhà xuất bản đáp ứng các yêu cầu tuân thủ quy định.
`restrictDataProcessing?`	Cho phép hoạt động phân phát chạy ở chế độ xử lý bị hạn chế để hỗ trợ nhà xuất bản đáp ứng các yêu cầu tuân thủ quy định.
`trafficSource?`	Cho biết liệu yêu cầu đại diện cho lưu lượng truy cập đã mua hay lưu lượng tự nhiên.
`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 các chế độ cài đặt quyền riêng tư

Thuộc tính

`Optional` childDirectedTreatment

childDirectedTreatment?: null | boolean

Cho biết liệu trang có được xem 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 hoạt động phân phát chạy ở chế độ quảng cáo bị hạn chế để hỗ trợ nhà xuất bản đáp ứng các yêu cầu 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.
Tự động, bằng cách đặt giá trị của trường này thành true.

URL quảng cáo bị hạn chế

cảnh báo trên Bảng điều khiển dành cho nhà xuất bản

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 hoạt động phân phát chạy ở chế độ quảng cáo không được cá nhân hoá để hỗ trợ nhà xuất bản đáp ứng các yêu cầu tuân thủ quy định.

`Optional` restrictDataProcessing

restrictDataProcessing?: boolean

Cho phép chạy hoạt động phân phát ở chế độ xử lý bị hạn chế nhằm hỗ trợ việc tuân thủ các quy định của nhà xuất bản.

`Optional` trafficSource

trafficSource?: TrafficSource

Cho biết liệu các yêu cầu có đại diện cho lưu lượng truy cập đã mua hay lưu lượng truy cập tự nhiên. Giá trị này sẽ điền sẵn phương diện Nguồn lưu lượng truy cập trong báo cáo Ad Manager. Nếu không được đặ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?: null | boolean

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

googletag.PubAdsService

Mở rộng Service

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

Phương thức

clear

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á 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, hoạt động khoanh vùng hoặc loại trừ cạnh tranh liên quan đến quảng cáo này sẽ không ảnh hưởng đến các yêu cầu trong tương lai.

Ví dụ:

JavaScript

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

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

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

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

JavaScript (cũ)

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

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

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

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

TypeScript

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

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

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

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

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

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

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 khung giờ.

Ví dụ:

JavaScript

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

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

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

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

JavaScript (cũ)

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

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

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

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

TypeScript

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

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

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

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

Xem thêm

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

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

clearTargeting

clearTargeting(key?: string): PubAdsService

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

Ví dụ:

JavaScript

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

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

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

JavaScript (cũ)

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

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

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

TypeScript

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

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

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

Xem thêm

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

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

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

Xem thêm

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

disableInitialLoad

disableInitialLoad(): void

Tắt các yêu cầu cho 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.

Xem thêm

display

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

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

Lưu ý: Khi phương thức này được gọi, hệ thống sẽ tạo một ảnh chụp nhanh của vị trí và trạng thái trang để đả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 vị trí hoặc trạng thái 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 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

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

enableLazyLoad

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

Bật tính năng tải lười trong GPT như được xác định bởi đối tượng cấu hình. Để biết thêm ví dụ chi tiết, hãy xem mẫu Tải từng phần.

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

Ví dụ:

JavaScript

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

JavaScript (cũ)

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

TypeScript

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

Xem thêm

Thông số

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 lười. Mọi cấu hình bị bỏ qua sẽ sử dụng cấu hình mặc định do Google đặt và sẽ được điều chỉnh theo thời gian. Để tắt một chế độ cài đặt cụ thể, chẳng hạn như lề tìm nạp, hãy đặt giá trị thành `-1`. `fetchMarginPercent` Khoảng cách tối thiểu từ khung nhìn hiện tại mà một vị trí 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ị trí quảng cáo vào khung nhìn", 100 có nghĩa là "khi quảng cáo cách 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ùng phải đáp ứng trước khi chúng tôi hiển thị quảng cáo. Điều này cho phép tải trước quảng cáo, nhưng chờ hiển thị và tải các tài nguyên phụ khác. 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ố được áp dụng cho lề trên thiết bị di động. Điều này cho phép thay đổi lề 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ùng có thể đạt được trước khi tìm nạp và hiển thị.

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 lười. Mọi cấu hình bị bỏ qua sẽ sử dụng cấu hình mặc định do Google đặt và sẽ được điều chỉnh theo thời gian. Để tắt một chế độ cài đặt cụ thể, chẳng hạn như lề tìm nạp, hãy đặt giá trị thành -1.

fetchMarginPercent

Khoảng cách tối thiểu từ khung nhìn hiện tại mà một vị trí 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ị trí quảng cáo vào khung nhìn", 100 có nghĩa là "khi quảng cáo cách 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ùng phải đáp ứng trước khi chúng tôi hiển thị quảng cáo. Điều này cho phép tải trước quảng cáo, nhưng chờ hiển thị và tải các tài nguyên phụ khác. 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ố được áp dụng cho lề trên thiết bị di động. Điều này cho phép thay đổi lề 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ùng có thể đạt được trước khi tìm nạp và hiển thị.

enableSingleRequest

enableSingleRequest(): boolean

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

Xem thêm

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

enableVideoAds

enableVideoAds(): void

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

get

get(key: string): null | string

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

Ví dụ:

JavaScript

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

JavaScript (cũ)

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

TypeScript

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

Xem thêm

Thuộc tính AdSense

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

Giá trị trả về
`null \| 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.

Ví dụ:

JavaScript

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

JavaScript (cũ)

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

TypeScript

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

Giá trị trả về
`string[]`	Mảng gồm các 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.

Ví dụ:

JavaScript

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

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

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

JavaScript (cũ)

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

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

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

TypeScript

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

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

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

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

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

getTargetingKeys

getTargetingKeys(): string[]

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

Ví dụ:

JavaScript

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

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

JavaScript (cũ)

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

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

TypeScript

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

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

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

isInitialLoadDisabled

isInitialLoadDisabled(): boolean

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

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?: null | Slot[], options?: { 
  changeCorrelator: boolean; 
}): void

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

Để hoạt động đúng cách trên tất cả trình duyệt, trước khi gọi refresh, bạn phải gọi display cho vị trí quảng cáo. Nếu bạn bỏ qua lệnh gọi đến display, 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 khung sẽ xoá quảng cáo cũ khỏi lượt xem trang tồn tại lâu dài 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 rào cản hoặc tiêu chí 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

Thông số

Optional slots: null | Slot[] Các vị trí cần làm mới. Không bắt buộc phải sử dụng mảng; tất cả các ô sẽ được làm mới nếu bạn không chỉ định mảng đó.

Thông số
`Optional slots: null \| Slot[]`	Các vị trí cần làm mới. Không bắt buộc phải sử dụng mảng; tất cả các ô sẽ được làm mới nếu bạn không chỉ định mảng đó.
`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 đối tượng liên kết mới để tìm nạp quảng cáo hay không. Các máy chủ quảng cáo của chúng tôi duy trì giá trị bộ tương quan này trong thời gian ngắn (hiện tại là trong 30 giây, nhưng có thể thay đổi), sao cho các yêu cầu có cùng bộ 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 ý: tuỳ chọn này không ảnh hưởng đến lượt xem trang tồn tại lâu của GPT. Lượt xem này tự động phản ánh những quảng cáo hiện có trên trang và không có thời gian hết hạn.

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 đối tượng liên kết mới để tìm nạp quảng cáo hay không. Các máy chủ quảng cáo của chúng tôi duy trì giá trị bộ tương quan này trong thời gian ngắn (hiện tại là trong 30 giây, nhưng có thể thay đổi), sao cho các yêu cầu có cùng bộ 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 ý: tuỳ chọn này không ảnh hưởng đến lượt xem trang tồn tại lâu của GPT. Lượt xem này tự động phản ánh những quảng cáo hiện có trên trang và không có thời gian hết hạn.

set

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

Đặt giá trị cho các thuộc tính AdSense áp dụng cho tất cả cá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ả các giá trị trước khi gọi display hoặc refresh.

Ví dụ:

JavaScript

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

JavaScript (cũ)

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

TypeScript

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

Xem thêm

Thuộc tính AdSense

Thông số
`key: string`	Tên 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.

Ví dụ:

JavaScript

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

JavaScript (cũ)

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

TypeScript

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

Xem thêm

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

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

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

setCentering

setCentering(centerAds: boolean): void

Bật và tắt tính năng căn giữa quảng cáo theo chiều ngang. 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.

Ví dụ:

JavaScript

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

JavaScript (cũ)

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

TypeScript

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

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

setForceSafeFrame

setForceSafeFrame(forceSafeFrame: boolean): PubAdsService

Thiết lập xem có bắt buộc phải hiển thị tất cả quảng cáo trên trang bằng vùng chứa SafeFrame hay không.

Vui lòng ghi nhớ 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 sau đó được thực hiện cho các vị trí tương ứng.
Chế độ cài đặt ở cấp vùng quảng cáo (nếu được chỉ định) sẽ luôn ghi đè chế độ cài đặt ở cấp trang.
Nếu bạn đặt thành true (ở cấp độ vị trí quảng cáo hoặc cấp trang), quảng cáo sẽ luôn hiển thị bằng vùng chứa SafeFrame, bất kể lựa chọn bạn 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, quảng cáo sẽ được hiển thị bằng vùng chứa SafeFrame tuỳ thuộc vào loại mẫu quảng cáo và lựa chọn được thực hiện trong giao diện người dùng Google Ad Manager.
Bạn nên thận trọng khi sử dụng API này vì có thể ảnh hưởng đến hành vi của những mẫu quảng cáo cố gắng vượt qua iFrames của họ hoặc phụ thuộc vào việc hiển thị trực tiếp các mẫu quảng cáo đó trên trang của nhà xuất bản.

Ví dụ:

JavaScript

googletag.pubads().setForceSafeFrame(true);

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

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

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

JavaScript (cũ)

googletag.pubads().setForceSafeFrame(true);

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

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

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

TypeScript

googletag.pubads().setForceSafeFrame(true);

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

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

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

Xem thêm

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

Thông số
`forceSafeFrame: boolean`	`true` để buộc tất cả quảng cáo trên trang hiển thị trong SafeFrames và `false` thay đổi chế độ cài đặt trước đó thành false. Việc đặt giá trị này thành `false` khi không chỉ định trước đó sẽ không thay đổi gì.

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

setLocation

setLocation(address: string): PubAdsService

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

Ví dụ:

JavaScript

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

JavaScript (cũ)

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

TypeScript

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

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

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

setPrivacySettings

setPrivacySettings(privacySettings: PrivacySettingsConfig): PubAdsService

Cho phép định cấu hình tất cả chế độ cài đặt quyền riêng tư từ một API duy nhất bằng cách sử dụng đố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

Thông số
`privacySettings: PrivacySettingsConfig`	Đối tượng chứa cấu hình 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ã 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ừ 32 đến 150 ký tự.

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

setSafeFrameConfig

setSafeFrameConfig(config: SafeFrameConfig): PubAdsService

Đặt các tuỳ chọ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 chuyể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ị lựa chọn ưu tiên cấp vị trí ghi đè nếu được chỉ định.

Ví dụ:

JavaScript

googletag.pubads().setForceSafeFrame(true);

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

const slotConfig = { allowOverlayExpansion: false };

googletag.pubads().setSafeFrameConfig(pageConfig);

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

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

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

JavaScript (cũ)

googletag.pubads().setForceSafeFrame(true);

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

var slotConfig = { allowOverlayExpansion: false };

googletag.pubads().setSafeFrameConfig(pageConfig);

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

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

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

TypeScript

googletag.pubads().setForceSafeFrame(true);

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

const slotConfig = { allowOverlayExpansion: false };

googletag.pubads().setSafeFrameConfig(pageConfig);

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

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

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

Xem thêm

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

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

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

setTargeting

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

Đặt thông 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ùng quảng cáo 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.

Ví dụ:

JavaScript

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

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

JavaScript (cũ)

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

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

TypeScript

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

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

Xem thêm

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

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

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

setVideoContent

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

Đặt thông tin 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 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ụ truyền dẫn nội dung của Google Ad Manager.

Xem thêm

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

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

updateCorrelator

updateCorrelator(): PubAdsService

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

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

Ví dụ:

JavaScript

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

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

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

JavaScript (cũ)

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

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

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

TypeScript

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

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

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

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

googletag.ResponseInformation

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

Thuộc tính
`advertiserId`	Mã 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: null | number

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

campaignId

campaignId: null | number

Mã của chiến dịch.

creativeId

creativeId: null | number

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

creativeTemplateId

creativeTemplateId: null | number

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

lineItemId

lineItemId: null | number

Mã của mục hàng.

googletag.RewardedPayload

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

Thuộc tính
`amount`	Số lượng mặt hàng trong phần thưởng.
`type`	Loại mặt hàng có trong phần thưởng (ví dụ: "đồng 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 mặt hàng trong phần thưởng.

type

type: string

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

googletag.SafeFrameConfig

Đối tượng cấu hình cho vùng chứa SafeFrame.

Thuộc tính
`allowOverlayExpansion?`	Liệu SafeFrame có cho phép nội dung quảng cáo mở rộng bằng cách phủ lên nội dung trang hay không.
`allowPushExpansion?`	Liệu SafeFrame có 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.
`sandbox?`	Liệu SafeFrame có nên sử dụng thuộc tính hộp cát HTML5 để ngăn điều hướng cấp cao nhất mà không cần sự 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

PubAdsService.setSafeFrameConfig

Thuộc tính

`Optional` allowOverlayExpansion

allowOverlayExpansion?: boolean

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

`Optional` allowPushExpansion

allowPushExpansion?: boolean

Liệu SafeFrame có 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` 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 đ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?: null | 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 vào 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.Service

Lớp dịch vụ cơ sở chứa các phương thức chung cho mọi 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 hàm JavaScript khi một sự kiện GPT cụ thể xảy ra trên trang.
`getSlots`	Lấy danh sách các khung giờ được liên kết với dịch vụ này.
`removeEventListener`	Xoá 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ý 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 được hỗ trợ:

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 các khung giờ được liên kết với dịch vụ này.

Giá trị trả về
`Slot[]`	Các khung giờ theo thứ tự 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 quy cách á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 kích thước.

Phương thức
`addSize`	Thêm mối liên kết từ một mảng có kích thước đơn (đại diện cho khung nhìn) vào một mảng có kích thước đơn hoặc nhiều kích thước đại diện cho vị trí.
`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 có kích thước đơn (đại diện cho khung nhìn) vào một mảng có kích thước đơn hoặc nhiều kích thước đại diện cho vị trí.

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 &lt; 640x480
  .build();

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

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

JavaScript (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 &lt; 640x480
  .build();

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

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

TypeScript

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

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

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

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

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

build

build(): null | SizeMappingArray

Tạo thông số bản đồ kích thước từ các ánh xạ đượ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, phương thức này sẽ trả về null. Nếu không, hàm 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ề
`null \| SizeMappingArray`	Kết quả do trình tạo này tạo ra. Có thể có giá trị rỗng nếu bạn cung cấp á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 Service vào vị trí này.
`clearCategoryExclusions`	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`	Xóa cụ thể hoặc tất cả các thông số nhắm mục tiêu cấp vùng tùy chỉnh cho vùng 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 khe cho khe này.
`get`	Trả về giá trị cho thuộc tính AdSense được liên kết với khoá đã cho cho vị trí 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`	Trả về danh sách khoá thuộc tính được đặt trên khe này.
`getCategoryExclusions`	Trả về nhãn loại trừ danh mục quảng cáo cho vị trí này.
`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ị trí `div` được cung cấp khi vị trí đó được xác định.
`getTargeting`	Trả về một thông số nhắm mục tiêu tuỳ chỉnh cụ thể được đặt trên vị trí này.
`getTargetingKeys`	Trả về danh sách tất cả khoá nhắm mục tiêu tuỳ chỉnh được đặt trên vị trí này.
`set`	Đặt giá trị cho một thuộc tính AdSense trên vị trí quảng cáo này.
`setCategoryExclusion`	Đặt một nhãn loại trừ danh mục quảng cáo cấp vùng trên vùng này.
`setClickUrl`	Đặt URL của lượt nhấp mà người dùng sẽ được chuyển hướng đến sau khi nhấp vào quảng cáo.
`setCollapseEmptyDiv`	Đặt xem có nên ẩn vùng `div` khi không có quảng cáo trong vùng đó hay không.
`setConfig`	Đặt các tuỳ chọn cấu hình chung cho vị trí này.
`setForceSafeFrame`	Định cấu hình xem có buộc hiển thị quảng cáo trong vùng này bằng vùng chứa SafeFrame hay không.
`setSafeFrameConfig`	Đặt các lựa chọn ưu tiên cấp khe cho cấu hình SafeFrame.
`setTargeting`	Đặt tham số nhắm mục tiêu tuỳ chỉnh cho vị trí này.
`updateTargetingFromMap`	Đặt các tham số nhắm mục tiêu tuỳ chỉnh cho vị trí 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

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

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

clearCategoryExclusions

clearCategoryExclusions(): Slot

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

Ví dụ:

JavaScript

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

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

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

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

JavaScript (cũ)

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

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

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

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

TypeScript

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

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

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

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

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

clearTargeting

clearTargeting(key?: string): Slot

Xoá một hoặc tất cả các thông số nhắm mục tiêu tuỳ chỉnh ở cấp vị trí cho vị trí này.

Ví dụ:

JavaScript

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

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

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

JavaScript (cũ)

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

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

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

TypeScript

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

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

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

Xem thêm

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

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

Giá trị trả về
`Slot`	Đối tượng vị trí 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ị trí cho vùng 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 liên kết kích thước. Bạn có thể sử dụng SizeMappingBuilder để tạo lớp này. Mỗi mối liên kết 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 khe mà phương thức được gọi.

get

get(key: string): null | 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.

Ví dụ:

JavaScript

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

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

JavaScript (cũ)

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

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

TypeScript

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

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

Xem thêm

Thuộc tính AdSense

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

Giá trị trả về
`null \| 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 khoá thuộc tính được đặt trên khe này. Để xem khoá của 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.getAttributeKeys.

Ví dụ:

JavaScript

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

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

JavaScript (cũ)

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

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

TypeScript

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

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

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

getCategoryExclusions

getCategoryExclusions(): string[]

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

Ví dụ:

JavaScript

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

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

JavaScript (cũ)

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

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

TypeScript

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

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

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

getResponseInformation

getResponseInformation(): null | ResponseInformation

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

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

getSlotElementId

getSlotElementId(): string

Trả về mã nhận dạng của vị trí div được cung cấp khi vị trí đó đượ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ã `div` của vùng.

getTargeting

getTargeting(key: string): string[]

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

Ví dụ:

JavaScript

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

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

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

JavaScript (cũ)

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

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

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

TypeScript

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

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

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

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

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

getTargetingKeys

getTargetingKeys(): string[]

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

Ví dụ:

JavaScript

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

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

JavaScript (cũ)

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

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

TypeScript

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

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

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

set

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

Đặt giá trị cho một 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ả các giá trị trước khi gọi display hoặc refresh.

Ví dụ:

JavaScript

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

JavaScript (cũ)

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

TypeScript

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

Xem thêm

Thuộc tính AdSense

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

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

setCategoryExclusion

setCategoryExclusion(categoryExclusion: string): Slot

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

Ví dụ:

JavaScript

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

JavaScript (cũ)

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

TypeScript

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

Xem thêm

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

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

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

setClickUrl

setClickUrl(value: string): Slot

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

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

Ví dụ:

JavaScript

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

JavaScript (cũ)

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

TypeScript

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

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

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

setCollapseEmptyDiv

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

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

Ví dụ:

JavaScript

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

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

JavaScript (cũ)

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

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

TypeScript

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

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

Xem thêm

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

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

setConfig

setConfig(slotConfig: SlotSettingsConfig): void

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

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

setForceSafeFrame

setForceSafeFrame(forceSafeFrame: boolean): Slot

Thiết lập xem có bắt buộc phải hiển thị quảng cáo trong vùng này bằng vùng chứa SafeFrame hay không.

Vui lòng ghi nhớ 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 sau đó được thực hiện cho các vị trí tương ứng.
Chế độ cài đặt ở cấp vùng quảng cáo (nếu được chỉ định) sẽ luôn ghi đè chế độ cài đặt ở cấp trang.
Nếu bạn đặt thành true (ở cấp độ vị trí quảng cáo hoặc cấp trang), quảng cáo sẽ luôn hiển thị bằng vùng chứa SafeFrame, bất kể lựa chọn bạn 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, quảng cáo sẽ được hiển thị bằng vùng chứa SafeFrame tuỳ thuộc vào loại mẫu quảng cáo và lựa chọn được thực hiện trong giao diện người dùng Google Ad Manager.
Bạn nên thận trọng khi sử dụng API này vì có thể ảnh hưởng đến hành vi của những mẫu quảng cáo cố gắng vượt qua iFrames của họ hoặc phụ thuộc vào việc hiển thị trực tiếp các mẫu quảng cáo đó trên trang của nhà xuất bản.

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 hiển thị trong SafeFrame và `false` để chọn không sử dụng chế độ cài đặt ở cấp trang (nếu có). Việc đặt thuộc tính này thành `false` khi không được chỉ định ở cấp trang sẽ không làm thay đổi bất cứ điều gì.

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

setSafeFrameConfig

setSafeFrameConfig(config: null | SafeFrameConfig): Slot

Đặt các lựa chọn ưu tiên cấp khe 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 bạn truyền một giá trị không hợp lệ cho khoá được nhận dạng.

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

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: null \| SafeFrameConfig`	Đối tượng cấu hình.

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

setTargeting

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

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

Ví dụ:

JavaScript

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

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

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

JavaScript (cũ)

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

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

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

TypeScript

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

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

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

Xem thêm

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

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

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

updateTargetingFromMap

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

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

Lưu ý:

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

Ví dụ:

JavaScript

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

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

JavaScript (cũ)

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

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

TypeScript

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

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

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

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

googletag.config

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

Giao diện
`AdExpansionConfig`	Các chế độ cài đặt để kiểm soát tính năng mở rộng quảng cáo.
`ComponentAuctionConfig`	Đối tượng đại diện cho một phiên đấu giá thành phần đơn lẻ trong phiên đấu giá quảng cáo trên thiết bị.
`InterstitialConfig`	Một đối tượng xác định hành vi của một vị trí quảng cáo xen kẽ.
`PageSettingsConfig`	Giao diện cấu hình chính cho các chế độ cài đặt cấp trang.
`PrivacyTreatmentsConfig`	Chế độ cài đặt để kiểm soát các biện pháp 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).
`SlotSettingsConfig`	Giao diện cấu hình chính cho chế độ cài đặt cấp khe.
`TaxonomyData`	Một đối tượng chứa các giá trị cho một Hệ thống phân loại.

Loại bí danh
`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).

Loại bí danh

InterstitialTrigger

InterstitialTrigger: "unhideWindow" | "navBar"

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

PrivacyTreatment

PrivacyTreatment: "disablePersonalization"

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

Hệ thống 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

googletag.config.AdExpansionConfig

Chế độ cài đặt để kiểm soát tính năng mở rộng quảng cáo.

Thuộc tính
`enabled?`	Liệu tính năng mở rộng quảng cáo có được 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 mở rộng quảng cáo có được bật hay tắt.

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

googletag.config.ComponentAuctionConfig

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

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

Xem thêm

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

Thuộc tính

auctionConfig

auctionConfig: null | { 
  auctionSignals?: unknown; 
  decisionLogicUrl: string; 
  interestGroupBuyers?: string[]; 
  perBuyerExperimentGroupIds?: { 
    [buyer: string]: number; 
  }; 
  perBuyerGroupLimits?: { 
    [buyer: string]: number; 
  }; 
  perBuyerSignals?: { 
    [buyer: string]: unknown; 
  }; 
  perBuyerTimeouts?: { 
    [buyer: string]: number; 
  }; 
  seller: string; 
  sellerExperimentGroupId?: number; 
  sellerSignals?: unknown; 
  sellerTimeout?: number; 
  trustedScoringSignalsUrl?: string; 
}

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

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

Ví dụ:

JavaScript

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

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

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

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

JavaScript (cũ)

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

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

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

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

TypeScript

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

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

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

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

Xem thêm

Protected Audience API: Khởi tạo phiên đấu giá trên thiết bị

configKey

configKey: string

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

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

googletag.config.InterstitialConfig

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

Thuộc tính
`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` đ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.

Việc đặt giá trị của điều kiện kích hoạt quảng cáo xen kẽ thành true sẽ bật điều kiện kích hoạt đó và false sẽ tắt điều kiện kích hoạ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.PageSettingsConfig

Giao diện cấu hình chính cho 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.

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

Ví dụ:

Chỉ các 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 sẽ được cập nhật theo từng lệnh gọi đến googletag.setConfig.

  // Configure feature charlie to echo = 1, foxtrot = true.
  googletag.setConfig({
      charlie: {
          echo: 1,
          foxtrot: true,
      }
  });

  // Update feature charlie to echo = 2. Since foxtrot was not specified,
  // the value is cleared.
  googletag.setConfig({
      charlie: {
          echo: 2
      }
  });

Bạn có thể xoá tất cả chế độ cài đặt cho một tính năng bằng cách truyền null.

  // Configure features delta, golf, and hotel.
  googletag.setConfig({
      delta: {...},
      golf: {...},
      hotel: {...},
  });

  // Feature delta and hotel are cleared, but feature golf remains set.
  googletag.setConfig({
      delta: null,
      hotel: null,
  });

Thuộc tính
`adExpansion?`	Chế độ cài đặt để kiểm soát tính năng mở rộng quảng cáo.
`adYield?`	Không dùng nữa.
`pps?`	Các 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.
`threadYield?`	Chế độ cài đặt để kiểm soát việc GPT có tạo ra chuỗi JS hay không khi hiển thị mẫu quảng cáo.

Thuộc tính

`Optional` adExpansion

adExpansion?: null | AdExpansionConfig

Các chế độ cài đặt để kiểm soát tính năng mở rộng quảng cáo.

`Optional` adYield

adYield?: null | "DISABLED" | "ENABLED_ALL_SLOTS"

`Optional` pps

pps?: null | 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?: null | PrivacyTreatmentsConfig

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

`Optional` threadYield

threadYield?: null | "DISABLED" | "ENABLED_ALL_SLOTS"

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

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

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

null (mặc định): GPT sẽ tạo luồng JS cho các khung ngoài khung nhìn.
ENABLED_ALL_SLOTS: GPT sẽ trả về luồng JS cho tất cả các khung, bất kể khung đó 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

Bộ lập lịch

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 loạt 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ác cách xử lý quyền riêng tư của nhà xuất bản cần bật.

Ví dụ:

JavaScript

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

JavaScript (cũ)

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

TypeScript

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

googletag.config.PublisherProvidedSignalsConfig

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

Thuộc tính
`taxonomies`	Đối tượng chứa mối liên kết Phân loại.

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

Thuộc tính

hệ thống phân loại

taxonomies: Partial<Record<Taxonomy, TaxonomyData>>

Một đối tượng chứa các mối liên kết Phân loại.

googletag.config.SlotSettingsConfig

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

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

Tất cả các thuộc tính được liệt kê bên dưới đều là ví dụ và không phản ánh các tính năng thực tế sử dụng setConfig. Đối với tập hợp 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 theo từng lệnh gọi đến Slot.setConfig.

  // Configure feature charlie to echo = 1, foxtrot = true.
  slot.setConfig({
      charlie: {
          echo: 1,
          foxtrot: true,
      }
  });

  // Update feature charlie to echo = 2. Since foxtrot was not specified,
  // the value is cleared.
  slot.setConfig({
      charlie: {
          echo: 2
      }
  });

Bạn có thể xoá tất cả chế độ cài đặt cho một tính năng bằng cách truyền null.

  // Configure features delta, golf, and hotel.
  slot.setConfig({
      delta: {...},
      golf: {...},
      hotel: {...},
  });

  // Feature delta and hotel are cleared, but feature golf remains set.
  slot.setConfig({
      delta: null,
      hotel: null,
  });

Thuộc tính
`adExpansion?`	Chế độ cài đặt để kiểm soát tính năng mở rộng quảng cáo.
`componentAuction?`	Một loạt các phiên đấu giá thành phần sẽ được đưa vào một phiên đấu giá quảng cáo trên thiết bị.
`interstitial?`	Các chế độ cài đặt kiểm soát hành vi của vùng quảng cáo xen kẽ.

Thuộc tính

`Optional` adExpansion

adExpansion?: AdExpansionConfig

Chế độ cài đặt để kiểm soát tính năng mở rộng quảng cáo.

`Optional` componentAuction

componentAuction?: ComponentAuctionConfig[]

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

`Optional` quảng cáo xen kẽ

interstitial?: InterstitialConfig

Các chế độ cài đặt kiểm soát hành vi của vùng quảng cáo xen kẽ.

googletag.config.TaxonomyData

Một đối tượng chứa các giá trị cho một Hệ thống phân loại.

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

Thuộc tính

giá trị

values: string[]

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

googletag.enums

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

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

Liệt kê

OutOfPageFormat

OutOfPageFormat

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

Xem thêm

defineOutOfPageSlot

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

TrafficSource

TrafficSource

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

Xem thêm

PrivacySettingsConfig.trafficSource

Thành phần liệt kê
`ORGANIC`	Nhập URL trực tiếp, tìm kiếm trang web hoặc 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 (mua lại hoặc từ hoạt động 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ả lập liên kết tên sự kiện với loại đối tượng sự kiện tương ứng cho Service.addEventListener và Service.removeEventListener.
`GameManualInterstitialSlotClosedEvent`	Sự kiện này được kích hoạt khi người dùng đóng một vị trí quảng cáo xen kẽ thủ công trong trò chơi.
`GameManualInterstitialSlotReadyEvent`	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.
`ImpressionViewableEvent`	Sự kiện này được kích hoạt khi một lượt hiển thị có thể xem, theo tiêu chí của Chế độ xem đang kích hoạt.
`RewardedSlotClosedEvent`	Sự kiện này được kích hoạt khi người dùng đóng vùng quảng cáo có tặng thưởng.
`RewardedSlotGrantedEvent`	Sự kiện này được kích hoạt khi phần thưởng được cấp cho việc xem một quảng cáo có tặng thưởng.
`RewardedSlotReadyEvent`	Sự kiện này được kích hoạt khi một quảng cáo có tặng thưởng đã sẵn sàng hiển thị.
`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 khung.
`SlotRequestedEvent`	Sự kiện này được kích hoạt khi có yêu cầu quảng cáo cho một vị trí cụ thể.
`SlotResponseReceived`	Sự kiện này được kích hoạt khi hệ thống đã nhận được phản hồi quảng cáo cho một vùng 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 khu vực của một vị trí quảng cáo thay đổi.

googletag.events.Event

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

Thuộc tính
`serviceName`	Tên của dịch vụ đã kích hoạt sự kiện.
`slot`	Khe đã 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.

khe

slot: Slot

Khe đã kích hoạt sự kiện.

googletag.events.EventTypeMap

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

Thuộc tính
`gameManualInterstitialSlotClosed`	Bí danh của events.GameManualInterstitialSlotClosedEvent.
`gameManualInterstitialSlotReady`	Email đại diện của 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.
`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 của events.GameManualInterstitialSlotClosedEvent.

gameManualInterstitialSlotReady

gameManualInterstitialSlotReady: GameManualInterstitialSlotReadyEvent

Bí danh cho events.GameManualInterstitialSlotReadyEvent.

impressionViewable

impressionViewable: ImpressionViewableEvent

Bí danh cho events.ImpressionViewableEvent.

rewardedSlotClosed

rewardedSlotClosed: RewardedSlotClosedEvent

Bí danh của events.RewardedSlotClosedEvent.

rewardedSlotGranted

rewardedSlotGranted: RewardedSlotGrantedEvent

Bí danh cho events.RewardedSlotGrantedEvent.

rewardedSlotReady

rewardedSlotReady: RewardedSlotReadyEvent

Bí danh cho events.RewardedSlotReadyEvent.

slotOnload

slotOnload: SlotOnloadEvent

Bí danh cho events.SlotOnloadEvent.

slotRenderEnded

slotRenderEnded: SlotRenderEndedEvent

Bí danh của 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

Mở rộng Event

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

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

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

Ví dụ:

JavaScript

// This listener is called when a game manual interstial slot is closed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);
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 interstial slot is closed.
var targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);
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 interstial slot is closed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);
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

googletag.events.GameManualInterstitialSlotReadyEvent

Mở rộng 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. Đã kế thừa từ `Event.serviceName`
`slot`	Khe đã kích hoạt sự kiện. Kế thừa từ `Event.slot`

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

Ví dụ:

JavaScript

// This listener is called when a game manual interstitial slot is ready to
// be displayed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);
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,
);
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,
);
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

Phương thức

makeGameManualInterstitialVisible

makeGameManualInterstitialVisible(): void

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

googletag.events.ImpressionViewableEvent

Mở rộng Event

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

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

Ví dụ:

JavaScript

// This listener is called when an impression becomes viewable.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("impressionViewable", (event) => {
  const slot = event.slot;
  console.log("Impression for slot", slot.getSlotElementId(), "became viewable.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

JavaScript (cũ)

// This listener is called when an impression becomes viewable.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("impressionViewable", function (event) {
  var slot = event.slot;
  console.log("Impression for slot", slot.getSlotElementId(), "became viewable.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

TypeScript

// This listener is called when an impression becomes viewable.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("impressionViewable", (event) => {
  const slot = event.slot;
  console.log("Impression for slot", slot.getSlotElementId(), "became viewable.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

Xem thêm

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

googletag.events.RewardedSlotClosedEvent

Mở rộng Event

Sự kiện này được kích hoạt khi người dùng đóng vùng quảng cáo có tặng thưởng. Lệnh 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. Đã kế thừa từ `Event.serviceName`
`slot`	Khe đã kích hoạt sự kiện. Đã kế thừa từ `Event.slot`

Ví dụ:

JavaScript

// This listener is called when the user closes a rewarded ad slot.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
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ũ)

// This listener is called when the user closes a rewarded ad slot.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
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

// This listener is called when the user closes a rewarded ad slot.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
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

googletag.events.RewardedSlotGrantedEvent

Mở rộng Event

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

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

Ví dụ:

JavaScript

// This listener is called whenever a reward is granted for a
// rewarded ad.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
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ũ)

// This listener is called whenever a reward is granted for a
// rewarded ad.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
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

// This listener is called whenever a reward is granted for a
// rewarded ad.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
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

Thuộc tính

trọng tải

payload: null | RewardedPayload

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

googletag.events.RewardedSlotReadyEvent

Mở rộng Event

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

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

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

Ví dụ:

JavaScript

// This listener is called when a rewarded ad slot becomes ready to be
// displayed.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
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.defineSlot("/1234567/example", [160, 600]);
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.defineSlot("/1234567/example", [160, 600]);
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

Phương thức

makeRewardedVisible

makeRewardedVisible(): void

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

googletag.events.SlotOnloadEvent

Mở rộng Event

Sự kiện này được kích hoạt khi iframe của mẫu quảng cáo kích hoạt sự kiện tải. Khi hiển thị quảng cáo đa phương tiện ở chế độ hiển thị đồng bộ, không có iframe nào được 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. Đã kế thừa từ `Event.serviceName`
`slot`	Khe đã kích hoạt sự kiện. Kế thừa từ `Event.slot`

Ví dụ:

JavaScript

// This listener is called when a creative iframe load event fires.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotOnload", (event) => {
  const slot = event.slot;
  console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

JavaScript (cũ)

// This listener is called when a creative iframe load event fires.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotOnload", function (event) {
  var slot = event.slot;
  console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

TypeScript

// This listener is called when a creative iframe load event fires.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotOnload", (event) => {
  const slot = event.slot;
  console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

Xem thêm

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

googletag.events.SlotRenderEndedEvent

Mở rộng Event

Sự kiện này được kích hoạt khi mã mẫu quảng cáo được chèn vào một vị trí. Sự kiện này sẽ xảy ra trước khi tìm nạp tài nguyên của mẫu quảng cáo, 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 cho quảng cáo của nhà quảng cáo.
`campaignId`	Mã chiến dịch của quảng cáo được hiển thị.
`companyIds`	Mã của các công ty đặt giá thầu cho quảng cáo thay thế đã hiển thị.
`creativeId`	Mã mẫu quảng cáo của quảng cáo đặt trước đã hiển thị.
`creativeTemplateId`	Mã mẫu mẫu quảng cáo của quảng cáo đặt trước được hiển thị.
`isBackfill`	Quảng cáo có phải là quảng cáo chèn lấp hay không.
`isEmpty`	Liệu có quảng cáo nào được trả về cho vị trí đó hay không.
`labelIds`	Không dùng nữa.
`lineItemId`	Mã mục hàng của quảng cáo đặt trước đã hiển thị.
`serviceName`	Tên của dịch vụ đã kích hoạt sự kiện. Kế thừa từ `Event.serviceName`
`size`	Cho biết kích thước pixel của mẫu quảng cáo được hiển thị.
`slot`	Khe đã kích hoạt sự kiện. Kế thừa từ `Event.slot`
`slotContentChanged`	Liệu nội dung của vị trí có thay đổi với quảng cáo đã 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 chèn lấp được hiển thị.
`sourceAgnosticLineItemId`	Mã mục hàng của quảng cáo thay thế hoặc quảng cáo đặt trước đã hiển thị.
`yieldGroupIds`	Mã của các nhóm lợi nhuận cho quảng cáo lấp đầy đã 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: null | 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 khung trống, quảng cáo lấp đầy và mẫu quảng cáo do các dịch vụ khác ngoài PubAdsService hiển thị.

campaignId

campaignId: null | number

Mã chiến dịch của quảng cáo đã hiển thị. Giá trị là null cho vị trí trống, quảng cáo chèn lấp và mẫu quảng cáo được hiển thị bằng các dịch vụ không phải là PubAdsService.

companyIds

companyIds: null | number[]

Mã của các công ty đặt giá thầu cho quảng cáo thay thế đã hiển thị. Giá trị là null đối với các khung 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: null | number

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

creativeTemplateId

creativeTemplateId: null | number

isBackfill

isBackfill: boolean

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

isEmpty

isEmpty: boolean

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

labelIds

labelIds: null | number[]

lineItemId

lineItemId: null | number

Mã mục hàng của quảng cáo đặt trước đã hiển thị. Giá trị là null cho vị trí trống, quảng cáo chèn lấp và mẫu quảng cáo được hiển thị bằng các dịch vụ không phải là PubAdsService.

kích thước

size: null | string | number[]

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

slotContentChanged

slotContentChanged: boolean

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

sourceAgnosticCreativeId

sourceAgnosticCreativeId: null | number

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

sourceAgnosticLineItemId

sourceAgnosticLineItemId: null | number

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

yieldGroupIds

yieldGroupIds: null | number[]

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

googletag.events.SlotRequestedEvent

Mở rộng Event

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

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

Ví dụ:

JavaScript

// This listener is called when the specified service issues an ad
// request for a slot. Each slot will fire this event, even though they
// may be batched together in a single request if single request
// architecture (SRA) is enabled.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotRequested", (event) => {
  const slot = event.slot;
  console.log("Slot", slot.getSlotElementId(), "has been requested.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

JavaScript (cũ)

// This listener is called when the specified service issues an ad
// request for a slot. Each slot will fire this event, even though they
// may be batched together in a single request if single request
// architecture (SRA) is enabled.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotRequested", function (event) {
  var slot = event.slot;
  console.log("Slot", slot.getSlotElementId(), "has been requested.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

TypeScript

// This listener is called when the specified service issues an ad
// request for a slot. Each slot will fire this event, even though they
// may be batched together in a single request if single request
// architecture (SRA) is enabled.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotRequested", (event) => {
  const slot = event.slot;
  console.log("Slot", slot.getSlotElementId(), "has been requested.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

Xem thêm

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

googletag.events.SlotResponseReceived

Mở rộng Event

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

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

Ví dụ:

JavaScript

// This listener is called when an ad response has been received
// for a slot.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotResponseReceived", (event) => {
  const slot = event.slot;
  console.log("Ad response for slot", slot.getSlotElementId(), "received.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

JavaScript (cũ)

// This listener is called when an ad response has been received
// for a slot.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotResponseReceived", function (event) {
  var slot = event.slot;
  console.log("Ad response for slot", slot.getSlotElementId(), "received.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

TypeScript

// This listener is called when an ad response has been received
// for a slot.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotResponseReceived", (event) => {
  const slot = event.slot;
  console.log("Ad response for slot", slot.getSlotElementId(), "received.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

Xem thêm

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

googletag.events.SlotVisibilityChangedEvent

Mở rộng Event

Sự kiện này đượ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 khu vực 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 1 lần/200 mili giây.

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

Ví dụ:

JavaScript

// This listener is called whenever the on-screen percentage of an
// ad slot's area changes.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotVisibilityChanged", (event) => {
  const slot = event.slot;
  console.group("Visibility of slot", slot.getSlotElementId(), "changed.");

  // Log details of the event.
  console.log("Visible area:", `${event.inViewPercentage}%`);
  console.groupEnd();

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

JavaScript (cũ)

// This listener is called whenever the on-screen percentage of an
// ad slot's area changes.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotVisibilityChanged", function (event) {
  var slot = event.slot;
  console.group("Visibility of slot", slot.getSlotElementId(), "changed.");

  // Log details of the event.
  console.log("Visible area:", "".concat(event.inViewPercentage, "%"));
  console.groupEnd();

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

TypeScript

// This listener is called whenever the on-screen percentage of an
// ad slot's area changes.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotVisibilityChanged", (event) => {
  const slot = event.slot;
  console.group("Visibility of slot", slot.getSlotElementId(), "changed.");

  // Log details of the event.
  console.log("Visible area:", `${event.inViewPercentage}%`);
  console.groupEnd();

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

Xem thêm

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

Thuộc tính

inViewPercentage

inViewPercentage: number

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

googletag.secureSignals

Đây là không gian tên mà GPT sử dụng để quản lý các 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 bảo mật cho một nhà xuất bản cụ thể.
`SecureSignalProvidersArray`	Giao diện để quản lý tín hiệu bảo mật.

Loại bí danh
`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ể.

Loại bí danh

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 một trong hai id hoặc networkCode, chứ 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ể.

Trì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:

Hàm thu thập trả về một Promise phân giải thành một tín hiệu an toàn.
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 một tín hiệu an toàn.
`id`	Giá trị nhận dạng duy nhất của trình thu thập dữ liệu được liên kết với tín hiệu an toàn này, như đã đăng ký trong Google Ad Manager.

Ví dụ:

JavaScript

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

JavaScript (cũ)

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

TypeScript

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

Xem thêm

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

Thuộc tính

collectorFunction

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

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

id

id: string

Giá trị nhận dạng duy nhất của trình thu thập dữ liệu đượ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ể.

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

Hàm thu thập trả về một Promise phân giải thành một tín hiệu an toàn.
networkCode xác định nhà xuất bản được liên kết với tín hiệu.

Để trả về tín hiệu an toàn cho bên đặt giá thầu, hãy sử dụng secureSignals.BidderSignalProvider.

Thuộc tính
`collectorFunction`	Một hàm trả về `Promise` phân giải thành một tín hiệu an toàn.
`networkCode`	Mã mạng (như trong đường dẫn đơn vị quảng cáo) của nhà xuất bản liên kết với tín hiệu an toàn này.

Ví dụ:

JavaScript

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

JavaScript (cũ)

// networkCode is provided
googletag.secureSignalProviders.push({
  networkCode: "123456",
  collectorFunction: function () {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});

TypeScript

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

Xem thêm

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

Thuộc tính

collectorFunction

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

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

networkCode

networkCode: string

Mã mạng (như trong đường dẫn đơn vị quảng cáo) cho nhà xuất bản được liên kết với tín hiệu an toàn này.

googletag.secureSignals.SecureSignalProvidersArray

Giao diện để quản lý các 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 từ bộ nhớ đệm.

Việc gọi phương thức này có thể làm giảm khả năng tín hiệu được đưa vào các yêu cầu quảng cáo cho lượt xem trang hiện tại và có thể là các lượt xem trang sau này. Do đó, bạn chỉ nên gọi phương thức này khi có thay đổi trạng thái có ý nghĩa, chẳng hạn như các sự kiện cho biết 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`	Thêm đối tượng secureSignals.SecureSignalProvider vào mảng.

Tài liệu tham khảo GPT

Chú thích kiểu

googletag

Loại bí danh

GeneralSize

MultiSize

NamedSize

SingleSize

SingleSizeArray

SizeMapping

SizeMappingArray

Biến

Const apiReady

Const cmd

JavaScript

JavaScript (cũ)

TypeScript

Const pubadsReady

secureSignalProviders

JavaScript

JavaScript (cũ)

TypeScript

Hàm

companionAds

defineOutOfPageSlot

JavaScript

JavaScript (cũ)

TypeScript

defineSlot

JavaScript

JavaScript (cũ)

TypeScript

destroySlots

JavaScript

JavaScript (cũ)

TypeScript

disablePublisherConsole

display

enableServices

getVersion

openConsole

JavaScript

JavaScript (cũ)

TypeScript

pubads

setAdIframeTitle

JavaScript

JavaScript (cũ)

TypeScript

setConfig

sizeMapping

googletag.CommandArray

Phương thức

push

JavaScript

JavaScript (cũ)

TypeScript

googletag.CompanionAdsService

Kế thừa từ Service.addEventListener

Kế thừa từ Service.getSlots

Kế thừa từ Service.removeEventListener

Phương thức

setRefreshUnfilledSlots

JavaScript

JavaScript (cũ)

TypeScript

googletag.PrivacySettingsConfig

Thuộc tính

Optional childDirectedTreatment

Optional limitedAds

JavaScript

JavaScript (cũ)

TypeScript

Optional nonPersonalizedAds

Optional restrictDataProcessing

Optional trafficSource

JavaScript

JavaScript (cũ)

TypeScript

Optional underAgeOfConsent

`Const` apiReady

`Const` cmd

`Const` pubadsReady

Kế thừa từ `Service.addEventListener`

Kế thừa từ `Service.getSlots`

Kế thừa từ `Service.removeEventListener`

`Optional` childDirectedTreatment

`Optional` limitedAds

`Optional` nonPersonalizedAds

`Optional` restrictDataProcessing

`Optional` trafficSource

`Optional` underAgeOfConsent

Kế thừa từ `Service.addEventListener`

Kế thừa từ `Service.getSlots`

Kế thừa từ `Service.removeEventListener`