Tệp đối chiếu

Thông số

Mô tả thông số cấp trang

Bạn chỉ cần chỉ định các thông số này một lần cho mỗi trang. Chúng ảnh hưởng đến tất cả các đơn vị trên trang.

Bắt buộc

Thông số Mô tả và ví dụ
adPage Bắt buộc khi người dùng chuyển đến trang kết quả tiếp theo hoặc trang kết quả trước đó.

Tham số adPage chỉ định trang kết quả mà quảng cáo đang được hiển thị. Thông số này được sử dụng khi người dùng điều hướng qua trang đầu tiên của kết quả tìm kiếm. Ví dụ: nếu 5 quảng cáo được yêu cầu và thông số adPage được đặt thành 2, thì quảng cáo được trả về sẽ là trang thứ hai của 5 quảng cáo.

pubId Bắt buộc
Đây là client-ID AdSense của bạn. pubId là một phần của client-ID, đứng sau 'partner-'. Ví dụ: nếu client-ID là 'partner-test-property', thì pubId của bạn là 'test-property'. Đây là giao thức chuẩn cho Quảng cáo tìm kiếm tuỳ chỉnh.

Ví dụ:

'pubId' : 'test-property'

query Bắt buộc, ngoại trừ Nội dung tìm kiếm có liên quan trên các trang Nội dung.
Đây là cụm từ tìm kiếm do người dùng nhập. Giá trị của tham số truy vấn sẽ không được mã hoá.

Lưu ý: Việc sử dụng thông số này trên Nội dung tìm kiếm có liên quan trên trang Nội dung sẽ dẫn đến kết quả không mong muốn.

Ví dụ:

'query' : 'flowers'
'query' : 'black & decker'
'query' : myQuery // myQuery is a variable containing the search query

resultsPageBaseUrl Bắt buộc khi trang có các đơn vị nội dung tìm kiếm có liên quan.
Chỉ định URL của trang kết quả tìm kiếm mà trên đó cụm từ tìm kiếm là cụm từ tìm kiếm có liên quan mà người dùng đã nhấp vào. resultsPageBaseUrl có thể bao gồm các thông số riêng, ngoại trừ cụm từ tìm kiếm sẽ được thêm tự động.

Ví dụ:

'resultsPageBaseUrl' : 'http://www.example.com/search?a=v1&b=v2'

relatedSearchTargeting Bắt buộc khi trang có các đơn vị nội dung tìm kiếm có liên quan.
Tham số này là bắt buộc khi yêu cầu các đơn vị nội dung tìm kiếm có liên quan. Thanh này kiểm soát loại trải nghiệm Nội dung tìm kiếm có liên quan sẽ hiển thị, tuỳ thuộc vào ngữ cảnh của trang:
  • 'content' Sử dụng tuỳ chọn này cho Nội dung tìm kiếm có liên quan trên các trang Nội dung (ví dụ: bài viết, bài đăng trên blog).
  • 'query' Sử dụng tuỳ chọn này dành riêng cho Nội dung tìm kiếm có liên quan trên các trang kết quả tìm kiếm.

Lưu ý: Theo mặc định, thông số trang relatedSearchTargeting được tự động đặt thành "truy vấn". Tuy nhiên, điều quan trọng cần lưu ý là giá trị mặc định này được thiết kế dành riêng cho các trang kết quả tìm kiếm chỉ (Nội dung tìm kiếm có liên quan trên Tìm kiếm). Nếu đang dùng nội dung tìm kiếm có liên quan trên bất kỳ loại trang nào khác (ví dụ: bài viết, bài đăng trên blog), bạn phải đặt rõ tham số này thành "content".

Lưu ý: Bạn phải tuân thủ các nguyên tắc sau đây khi sử dụng thông số này:

  • Một số tính năng tìm kiếm có liên quan có thể được bật hoặc tắt tuỳ thuộc vào giá trị của tham số trang này.
  • Việc trình bày sai về loại trang hoặc dựa vào chế độ cài đặt "truy vấn" mặc định cho tham số relatedSearchTargeting trên các trang không phải kết quả tìm kiếm sẽ bị coi là vi phạm hướng dẫn bằng văn bản này.
  • Google có thể xác minh tính chính xác của giá trị này theo định kỳ, bất kể giá trị đó được đặt theo cách thủ công hay sử dụng giá trị mặc định.

Ví dụ:

'relatedSearchTargeting' : 'content'
'relatedSearchTargeting' : 'query'
styleId Bắt buộc
Chỉ định mã của kiểu tìm kiếm tuỳ chỉnh sẽ được áp dụng cho quảng cáo hoặc đơn vị nội dung tìm kiếm có liên quan trên trang. Tìm hiểu thêm về cách sử dụng kiểu tìm kiếm tuỳ chỉnh. Xin lưu ý rằng khi bạn đặt styleId cho một yêu cầu, quảng cáo hoặc nội dung tìm kiếm có liên quan sẽ hiển thị với kiểu đó và các tham số định kiểu cũ sẽ bị bỏ qua. Nếu styleId không được chỉ định trong yêu cầu, thì kiểu mặc định của hệ thống sẽ hiển thị.

Ví dụ:

'styleId': '1234567890'

Không bắt buộc

Thông số Mô tả và ví dụ
linkTarget Không bắt buộc
Chỉ định xem quảng cáo sẽ mở ra trong cùng một cửa sổ hay trong một cửa sổ mới khi người dùng nhấp vào. Giá trị mặc định là '_top'. Bạn cũng có thể dùng thông số này ở cấp đơn vị.
  • '_top' Mở trong cùng một cửa sổ.
  • '_blank' Mở trong cửa sổ mới.

Ví dụ:

'linkTarget' : '_blank'

maxTermLength Không bắt buộc
Chỉ định số lượng ký tự tối đa của một cụm từ tìm kiếm có liên quan, bao gồm cả dấu cách. Không có giá trị tối đa nếu không được đặt.

Ví dụ:

'maxTermLength' : 50

referrerAdCreative Không bắt buộc
Nếu người dùng truy cập vào trang nội dung có chứa đơn vị Nội dung tìm kiếm có liên quan cho nội dung bằng cách nhấp vào một quảng cáo hoặc đường liên kết trên một trang web khác và bạn thuộc quyền kiểm soát của quảng cáo hoặc đường liên kết đó, thì bạn phải đặt thông số này thành văn bản mẫu quảng cáo của quảng cáo hoặc đường liên kết đó theo nguyên văn.

Bạn phải tuân thủ các nguyên tắc sau đây khi sử dụng thông số này:

  • Bạn chỉ nên cung cấp tham số này trong yêu cầu Nội dung tìm kiếm có liên quan cho nội dung và sẽ bị bỏ qua đối với mọi yêu cầu khác.
  • Bạn chỉ nên dùng tính năng này cho lưu lượng truy cập mà bạn chủ định lấy từ các trang web khác, và không nên dùng cho lưu lượng tự nhiên.
  • Tiêu đề này phải bao gồm dòng tiêu đề và/hoặc thông tin mô tả của mẫu quảng cáo hoặc đường liên kết.
  • Việc đưa vào các giá trị không thuộc mẫu quảng cáo dạng đường liên kết hoặc quảng cáo bị coi là vi phạm các hướng dẫn bằng văn bản này.
  • Trường này không phân biệt chữ hoa chữ thường.
  • Lớp này chấp nhận phương thức mã hoá UTF-8 hợp lệ; hỗ trợ các ký tự Unicode / dấu phụ.
  • Google có thể sử dụng hoặc bỏ qua thông số bạn gửi. Khi được sử dụng, giá trị này có thể ảnh hưởng đến việc lựa chọn và thứ hạng của các từ khoá.

Lưu ý: Tham số này là bắt buộc khi sử dụng tham số terms.

Ví dụ:

'referrerAdCreative': 'search for ads related to dental implants'

'referrerAdCreative': 'The Early Signs of Psoriatic Arthritis'

resultsPageQueryParam Không bắt buộc
Chỉ định tên của tham số URL cho cụm từ tìm kiếm trên trang kết quả tìm kiếm. Giá trị mặc định là "q" nếu không được chỉ định.

Ví dụ:

'resultsPageQueryParam' : 'query'

terms Không bắt buộc
Tham số này cho phép bạn cung cấp danh sách được phân tách bằng dấu phẩy gồm các cụm từ tìm kiếm có liên quan của riêng bạn để được trả về cùng với yêu cầu tìm kiếm có liên quan, mặc dù Google có thể hoặc không sử dụng các cụm từ được cung cấp ở đây.

Lưu ý: Khi dùng tham số này, referrerAdCreative cũng là bắt buộcrelatedSearchTargeting là bắt buộc và phải được đặt thành "content".

Ví dụ:

'terms' : 'cars rental, flight ticket'

ignoredPageParams Không bắt buộc
Chỉ định danh sách tham số URL cho một trang nội dung có đơn vị Nội dung tìm kiếm có liên quan cho nội dung mà bạn có thể bỏ qua một cách an toàn mà không ảnh hưởng đến nội dung cốt lõi hoặc trải nghiệm người dùng.

Lưu ý: Trước khi cụm từ tìm kiếm có liên quan có thể xuất hiện trên trang web của bạn, Google cần thu thập dữ liệu các trang của bạn để đảm bảo rằng những cụm từ đó phù hợp với ngữ cảnh. Khi một trang chưa được thu thập dữ liệu hoặc bị trình thu thập dữ liệu của AdSense chặn thu thập dữ liệu (ví dụ: bị tệp robots.txt), chúng tôi sẽ không hiển thị các cụm từ Tìm kiếm có liên quan mà bạn đề xuất mà bạn cung cấp cho Google.

Sản phẩm Nội dung tìm kiếm có liên quan trên nội dung hoạt động dựa trên hệ thống thu thập dữ liệu nội dung của Google để lập chỉ mục các trang và tạo những cụm từ tìm kiếm có liên quan. URL trang nội dung chứa các tham số truy vấn như biến theo dõi, mã nhận dạng người dùng, mã phiên hoặc các giá trị nhận dạng động khác có thể ảnh hưởng đến khả năng đánh giá nội dung cốt lõi của trang của trình thu thập thông tin, đồng thời có thể dẫn đến các cụm từ tìm kiếm không chính xác hoặc không liên quan. Tham số trang này hướng dẫn trình thu thập dữ liệu của Google bỏ qua các tham số không cần thiết này để đảm bảo lập chỉ mục nội dung phù hợp và giảm tải thu thập dữ liệu không cần thiết. Điều này giúp Google nhận dạng chính xác hơn một trang là đã được thu thập dữ liệu và bắt đầu cho thấy các cụm từ đề xuất (cả Google và của đối tác, nếu đủ điều kiện).

Bạn phải tuân thủ các nguyên tắc sau đây khi sử dụng thông số này:

  • Bạn chỉ nên cung cấp tham số này trong yêu cầu Nội dung tìm kiếm có liên quan cho nội dung và sẽ bị bỏ qua đối với mọi yêu cầu khác.
  • Giá trị của tham số này phải là danh sách các tham số URL được phân tách bằng dấu phẩy. Danh sách này có thể xuất hiện khi bất kỳ người dùng nào chuyển đến trang nội dung.
  • Mã này có phân biệt chữ hoa chữ thường.
  • Khi bất kỳ tham số URL nào trong danh sách này bị xoá khỏi URL của trang nội dung, thì nội dung, giao diện hoặc trải nghiệm người dùng của trang sẽ không bị ảnh hưởng đáng kể.
  • Việc đưa vào một tham số URL ảnh hưởng đáng kể đến nội dung, giao diện hoặc trải nghiệm người dùng của trang bị coi là vi phạm hướng dẫn bằng văn bản này.
  • Google có thể định kỳ xác minh tác động của việc bỏ qua các tham số URL được cung cấp.

Ví dụ:
Người dùng truy cập vào một trang nội dung và có URL:

http://example.com/content?utm_medium=social&page_id=123&click_id=456
Cung cấp các tham số URL có thể bỏ qua sau:
'ignoredPageParams' : 'utm_medium,click_id,session_ref'
Sẽ coi URL của trang nội dung là:
http://example.com/content?page_id=123

Cài đặt cấu hình

Thông số Mô tả và ví dụ
adsafe Không bắt buộc
Chỉ định quy tắc lọc mà Google cần áp dụng cho những quảng cáo khớp với cụm từ tìm kiếm. Sau đây là các chế độ cài đặt hợp lệ cho adsafe và tác động của từng giá trị đối với quảng cáo trả về:
  • 'high' Trả về quảng cáo an toàn cho gia đình. Không trả về quảng cáo không an toàn cho gia đình hoặc có nội dung tình dục người lớn.
  • 'medium' Trả về quảng cáo an toàn cho gia đình và không an toàn cho gia đình. Không trả về quảng cáo có nội dung tình dục người lớn.
  • 'low' Trả về tất cả các loại quảng cáo.

Theo mặc định, adsafe được đặt ở mức cao.

Ví dụ:

'adsafe': 'medium'

adtest Không bắt buộc
Thông số adtest được dùng để cho biết rằng yêu cầu đối với quảng cáo là một thử nghiệm. Khi thông số adtest có giá trị on, Google sẽ coi yêu cầu đó là thử nghiệm và không tính số lượt hiển thị quảng cáo hoặc theo dõi kết quả nhấp chuột.

Khi thông số adtest có giá trị on, bạn sẽ không tạo ra doanh thu.

Các yêu cầu quảng cáo có thông số adtest được đặt thành on đến từ một miền chưa được phê duyệt trong thẻ Trang web sẽ trả về các quảng cáo có lớp phủ "quảng cáo thử nghiệm" và không thể nhấp vào.

Hãy sử dụng thông số này khi thử nghiệm, nhưng không sử dụng thông số trong các hệ thống sản xuất. Nếu không, bạn sẽ không được thanh toán cho những quảng cáo mà mình hiển thị.

Giá trị adtest mặc định bị tắt.

Ví dụ:

'adtest' : 'on'

channel Không bắt buộc
Bạn có thể bao gồm một kênh AdSense cho Tìm kiếm để theo dõi hiệu suất của các trang khác nhau. Sử dụng mã nhận dạng kênh duy nhất do Nhà quản lý tài khoản hỗ trợ kỹ thuật tạo trong tài khoản AdSense của bạn. Tìm hiểu thêm về kênh tại đây.

Các kênh phải được phân tách bằng dấu "+".

Ví dụ:

'channel' :  'testA'  
'channel' :  'testA+testB'  

hl Không bắt buộc
Thông số này xác định ngôn ngữ mà các quảng cáo được yêu cầu hoặc nội dung tìm kiếm có liên quan nên nhắm mục tiêu. Giá trị mặc định là en.

Google hỗ trợ tất cả các mã ngôn ngữ API AdWords.

Lưu ý: Nhà quảng cáo chỉ định ngôn ngữ mà quảng cáo của họ nhắm mục tiêu. Nếu bạn đưa thông số này vào yêu cầu của mình, thì Google chỉ trả về các quảng cáo được nhắm mục tiêu cho ngôn ngữ đó hoặc được nhắm mục tiêu cho tất cả các ngôn ngữ, nhưng không đảm bảo rằng văn bản quảng cáo sẽ bằng ngôn ngữ được chỉ định.

Thông thường, bạn nên đặt thông số hl thành ngôn ngữ chính của trang sẽ gửi thông số này.

Ví dụ:

'hl' : 'es'

ie Không bắt buộc

Tham số ie đặt lược đồ mã hoá ký tự sẽ được dùng để diễn giải chuỗi truy vấn.

Giá trị ie mặc định là utf-8.

Giá trị Tên chuẩn Ngôn ngữ được liên kết hỗ trợ
latin1 ISO-8859-1 Tây Âu (tiếng Catalan, tiếng Đan Mạch, tiếng Hà Lan, tiếng Anh, tiếng Phần Lan, tiếng Pháp, tiếng Đức, tiếng Indonesia, tiếng Ý, tiếng Na Uy, tiếng Bồ Đào Nha, tiếng Tây Ban Nha, tiếng Thuỵ Điển)
latin2 ISO-8859-2 Đông Âu (tiếng Croatia, tiếng Séc, tiếng Hungary, tiếng Ba Lan, tiếng Rumani, tiếng Serbia, tiếng Slovak, tiếng Slovenia)
latin3 ISO-8859-3  
latin4 ISO-8859-4 Tiếng Ban-tích (tiếng Estonia, tiếng Latvia, tiếng Lithuania)
chữ thập ISO-8859-5 Tiếng Bulgaria, tiếng Nga
arabic ISO-8859-6  
hy lạp ISO-8859-7 Tiếng Hy Lạp
hebrew ISO-8859-8 Tiếng Do Thái
latin5 ISO-8859-9  
latin6 ISO-8859-10 Tiếng Iceland
euc-jp EUC-Nhật Bản Tiếng Nhật
EUc-kr EUC–KR Tiếng Hàn
sjis Shift_JIS Tiếng Nhật
big5 Big5 Tiếng Trung phồn thể
gb GB2312 Tiếng Trung giản thể
utf-8 UTF-8 Tất cả
oe Không bắt buộc

Thông số oe đặt lược đồ mã hoá ký tự mà Google sẽ sử dụng để mã hoá văn bản của quảng cáo. Mặc dù về mặt kỹ thuật là không bắt buộc, bạn nên truyền một giá trị cho thông số này.

Giá trị oe mặc định là utf-8.

Giá trị Tên chuẩn Ngôn ngữ được liên kết hỗ trợ
latin1 ISO-8859-1 Tây Âu (tiếng Catalan, tiếng Đan Mạch, tiếng Hà Lan, tiếng Anh, tiếng Phần Lan, tiếng Pháp, tiếng Đức, tiếng Indonesia, tiếng Ý, tiếng Na Uy, tiếng Bồ Đào Nha, tiếng Tây Ban Nha, tiếng Thuỵ Điển)
latin2 ISO-8859-2 Đông Âu (tiếng Croatia, tiếng Séc, tiếng Hungary, tiếng Ba Lan, tiếng Rumani, tiếng Serbia, tiếng Slovak, tiếng Slovenia)
latin3 ISO-8859-3  
latin4 ISO-8859-4 Tiếng Ban-tích (tiếng Estonia, tiếng Latvia, tiếng Lithuania)
chữ thập ISO-8859-5 Tiếng Bulgaria, tiếng Nga
arabic ISO-8859-6  
hy lạp ISO-8859-7 Tiếng Hy Lạp
hebrew ISO-8859-8 Tiếng Do Thái
latin5 ISO-8859-9  
latin6 ISO-8859-10 Tiếng Iceland
euc-jp EUC-Nhật Bản Tiếng Nhật
EUc-kr EUC–KR Tiếng Hàn
sjis Shift_JIS Tiếng Nhật
gb GB2312 Tiếng Trung giản thể
utf-8 UTF-8 Tất cả
ivt Không bắt buộc
Thông số này cho phép bạn cung cấp giá trị boolean cho Google biết rằng bạn muốn cho phép quảng cáo sử dụng cookie chỉ dùng để phát hiện lưu lượng truy cập không hợp lệ và phương pháp lưu trữ cục bộ trên cả lưu lượng truy cập có sự đồng ý và không có sự đồng ý của người dùng.
  • true Khi thông số này không xuất hiện hoặc bạn đặt thành "true", chúng tôi sẽ đặt cookie chỉ dùng để phát hiện lưu lượng truy cập không hợp lệ và chỉ sử dụng phương pháp lưu trữ cục bộ cho lưu lượng truy cập có sự đồng ý.
  • false Khi bạn đặt thông số này thành "false", chúng tôi sẽ đặt cookie chỉ dùng để phát hiện lưu lượng truy cập không hợp lệ và sử dụng phương pháp lưu trữ cục bộ cho cả lưu lượng truy cập có sự đồng ý và không có sự đồng ý của người dùng.

Theo mặc định, IVT được đặt thành true.

Ví dụ:

'ivt': false

Mô tả thông số cấp đơn vị

Những thông số này ảnh hưởng đến cách hiển thị các đơn vị quảng cáo riêng lẻ trên trang cho người dùng, mỗi thông số có thể được đặt riêng lẻ cho từng đơn vị quảng cáo.

Bắt buộc

Thông số Mô tả và ví dụ
container Bắt buộc
Mã của vùng chứa quảng cáo trống <div> nơi quảng cáo sẽ xuất hiện.

Ví dụ:

'container' : 'afscontainer1'

maxTop Bắt buộc khi đơn vị quảng cáo nằm phía trên kết quả tìm kiếm.

Sử dụng thông số này để chỉ định số lượng quảng cáo sẽ hiển thị trên đơn vị quảng cáo hàng đầu.

Lưu ý: Thông số này được dùng thay cho thông số "number". Đơn vị quảng cáo này phải đủ rộng để dòng đầu tiên của quảng cáo không bị che khuất. Việc sử dụng thông số maxTop trên bất kỳ vị trí nào khác trên trang là hành vi vi phạm chính sách.

Ví dụ:

'maxTop' : 4
width Bắt buộc
Chỉ định chiều rộng của quảng cáo hoặc đơn vị tìm kiếm có liên quan theo pixel.

Ví dụ:

'width' : '700px'
'width' : 700

Cài đặt cấu hình

Thông số Mô tả và ví dụ
adLoadedCallback Không bắt buộc
Chỉ định hàm JavaScript sẽ được gọi khi quảng cáo hoặc nội dung tìm kiếm có liên quan đã tải hoặc khi không có quảng cáo hay nội dung tìm kiếm có liên quan nào được phân phát. Bạn nên đặt thông số này thành hàm callback JavaScript mà bạn triển khai để cho phép thực hiện hành động khi lệnh gọi quảng cáo hoàn tất.

Hàm callback có các tham số sau:

containerName Tên vùng chứa của quảng cáo hoặc đơn vị nội dung tìm kiếm có liên quan.
adsLoaded Đặt thành true khi có ít nhất một quảng cáo hoặc cụm từ tìm kiếm có liên quan hiển thị và đặt thành false khi không có quảng cáo hoặc nội dung tìm kiếm có liên quan nào được trả về.
isExperimentVariant Đặt thành true nếu một thử nghiệm định kiểu tuỳ chỉnh đang chạy và biến thể của thử nghiệm đó được chọn để hiển thị quảng cáo.
callbackOptions Đối tượng JSON có chứa các trường sau:
termPositions: Đối với một khối nội dung tìm kiếm có liên quan, hãy chứa một map<string,int> của các cụm từ do nhà xuất bản cung cấp đến vị trí được lập chỉ mục bằng 0 của các cụm từ này trong nội dung phản hồi. Nếu một từ khoá được cung cấp nhưng không được trả về, nó sẽ không xuất hiện trên bản đồ.

Lưu ý: Vui lòng kiểm tra hàm callback của bạn để đảm bảo hàm không tạo ra bất kỳ lỗi nào, đặc biệt là những lỗi có thể ảnh hưởng đến việc tải trang của bạn.

Ví dụ về lệnh gọi lại JavaScript:

var adblock1 = {
  'container' : 'adblock1_div_id',
  'adLoadedCallback' : function(containerName, adsLoaded,
    isExperimentVariant, callbackOptions) {
    if (adsLoaded) {
       try {
         // most likely do nothing
       } catch (e) {
         alert ("Error in callback function");
         // Do something to handle error gracefully
       }
    } else {
       // as you always do when there is no ad coverage from Google
    }
  }
};
      

number Không bắt buộc
Số lượng quảng cáo sẽ xuất hiện trong đơn vị này. Giá trị mặc định là 2.

Ví dụ:

'number' : 4

relatedSearches Không bắt buộc
Số lượng nội dung tìm kiếm có liên quan sẽ xuất hiện trong đơn vị này. Giá trị mặc định là 0 nếu không được chỉ định.

Ví dụ:

'relatedSearches' : 4