Sự đồng ý bên trong iframe khác nguồn gốc: Mẫu __tcfapiLocator và __gppLocator
Vấn đề: Sự đồng ý nằm ở cửa sổ cấp cao nhất
CMP chạy trên trang của bạn, trong cửa sổ cấp cao nhất. Phần lớn quảng cáo của bạn thì không. Các creative hiển thị, rich media, bộ kết xuất header bidding và nhiều widget bên thứ ba chạy bên trong iframe, thường ở một origin khác. Mã trong một iframe khác origin không thể gọi trực tiếp một hàm trên trang cha, nên nó không thể đơn giản gọi __tcfapi hoặc __gpp để đọc lựa chọn của khách truy cập.
Các khung của IAB giải quyết điều này bằng một quy ước nhắn tin nhỏ gọn, được xác định rõ ràng. Nếu bạn xây dựng các sản phẩm quảng cáo, nội dung nhúng hoặc tập lệnh đo lường chạy trong các khung, hoặc nếu bạn gỡ lỗi các hệ thống quảng cáo như vậy, thật đáng để biết chính xác nó hoạt động ra sao.
Khung định vị
Bên cạnh API JavaScript, một CMP TCF thêm một iframe rỗng, vô hình có tên __tcfapiLocator vào trang cấp cao nhất. Một CMP GPP làm điều tương tự với một khung có tên __gppLocator. Các khung này không chứa nội dung. Nhiệm vụ duy nhất của chúng là có thể được tìm thấy: bất kỳ tập lệnh nào trong bất kỳ khung lồng nhau nào cũng có thể đi ngược lên cây cửa sổ và kiểm tra xem ở mỗi cấp có khung với tên đó hay không.
Vì tên khung có thể thấy được giữa các origin thông qua window.frames, một tập lệnh trong iframe khác origin lồng sâu có thể xác định cửa sổ chứa CMP mà không cần truy cập bất cứ thứ gì khác trên trang đó.
Cách một tập lệnh trong khung tìm thấy CMP
- Bắt đầu với cửa sổ hiện tại. Nếu __tcfapi tồn tại cục bộ, hãy dùng nó trực tiếp — tập lệnh không nằm trong khung, hoặc khung đó dùng chung CMP.
- Nếu không, lặp ngược lên: kiểm tra xem cửa sổ hiện tại có chứa khung tên __tcfapiLocator hay không; nếu không, chuyển sang window.parent và kiểm tra lại, dừng ở cửa sổ cấp cao nhất.
- Khi tìm thấy khung định vị, cửa sổ chứa nó chính là cửa sổ của CMP. Giao tiếp từ lúc này diễn ra qua postMessage.
Hãy bọc mỗi lần truy cập trong try/catch, vì một số trình duyệt hoặc cài đặt sandbox ném lỗi khi truy cập thuộc tính khác origin, và dừng vòng lặp khi window.parent bằng với cửa sổ hiện tại.
Định dạng thông điệp
Với TCF, tập lệnh trong khung gửi một thông điệp đến cửa sổ CMP chứa một đối tượng có thuộc tính __tcfapiCall. Bên trong có bốn trường:
- command — ví dụ getTCData, ping hoặc addEventListener;
- parameter — mọi đối số mà lệnh cần, hoặc null;
- version — phiên bản API, là 2 đối với TCF v2;
- callId — một giá trị duy nhất do bên gọi tạo ra.
CMP lắng nghe các thông điệp này, chạy lệnh và gửi lại một đối tượng có thuộc tính __tcfapiReturn chứa returnValue, success và cùng callId. Bên gọi giữ một bản đồ các callback đang chờ theo khóa callId, lắng nghe các sự kiện message và chuyển mỗi giá trị trả về đến đúng callback. GPP theo cùng một mẫu với __gppCall và __gppReturn.
Nhiều tích hợp viết một proxy nhỏ: một hàm cục bộ tên __tcfapi bên trong khung chuyển các lệnh gọi thành thông điệp. Mã được viết cho cửa sổ cấp cao nhất khi đó hoạt động không thay đổi bên trong khung.
Trình lắng nghe sự kiện xuyên các khung
Một lệnh gọi addEventListener được gửi qua postMessage không phải là một yêu cầu một lần. CMP sẽ gửi một thông điệp trả về mỗi khi trạng thái đồng ý thay đổi, tất cả đều có cùng callId. Do đó bộ điều phối của bạn phải giữ callback đó được đăng ký thay vì xóa nó sau phản hồi đầu tiên. Quên điều này là một lỗi kinh điển: tập lệnh trong khung đọc sự đồng ý một lần và không bao giờ nhận ra việc rút lại sau đó.
Các cân nhắc về bảo mật
- Xác thực hình dạng thông điệp. Bỏ qua mọi thông điệp không chứa thuộc tính mong đợi, và phân tích cú pháp các payload dạng chuỗi một cách thận trọng, vì một số triển khai gửi chuỗi JSON thay vì đối tượng.
- Đừng tin một cách mù quáng. Bất kỳ trang nào cũng có thể gửi thông điệp đến khung của bạn. Hãy coi các phản hồi là tín hiệu đồng ý cần tôn trọng, không phải dữ liệu đã được xác thực, và đừng bao giờ để chúng kích hoạt các hành động có đặc quyền.
- Dùng origin đích cụ thể khi có thể. Khi biết origin của CMP, hãy gửi đến đó thay vì đến mọi origin.
Nơi mẫu này không với tới
Một số môi trường quảng cáo cô lập creative nghiêm ngặt hơn. Các container SafeFrame, iframe sandbox không có quyền phù hợp và các creative được kết xuất trong tài liệu riêng có thể không thể duyệt cây khung hoặc nhận thông điệp. Trong những trường hợp đó, tín hiệu đồng ý thường phải được truyền vào một cách tường minh, ví dụ dưới dạng tham số trên yêu cầu quảng cáo hoặc các giá trị do máy chủ quảng cáo giao cho creative, chẳng hạn các tham số gdpr và gdpr_consent mà nhiều thẻ quảng cáo hỗ trợ.
Danh sách kiểm tra gỡ lỗi
- Trong DevTools của cửa sổ cấp cao nhất, xác nhận các khung định vị tồn tại trong bảng Elements.
- Chuyển ngữ cảnh bảng điều khiển sang iframe và kiểm tra xem có thể tiếp cận khung định vị từ đó hay không.
- Ghi nhật ký các sự kiện message đến ở cả hai cửa sổ để xác nhận các lệnh gọi và giá trị trả về đang luân chuyển.
- Thay đổi sự đồng ý trong biểu ngữ và xác minh các trình lắng nghe trong khung nhận được bản cập nhật.
- Kiểm thử với CMP tải muộn, để đảm bảo mã trong khung thử lại hoặc chờ đợi thay vì bỏ cuộc ngay lập tức.
Những điểm chính cần nhớ
- Các khung khác origin tiếp cận CMP thông qua các khung __tcfapiLocator và __gppLocator.
- Các lệnh gọi và giá trị trả về dùng postMessage với __tcfapiCall/__tcfapiReturn hoặc các tương đương của GPP, được ghép theo callId.
- Giữ các callback của trình lắng nghe được đăng ký để các thay đổi đồng ý sau đó được chuyển đến.
- Xác thực mọi thông điệp và tránh coi nó là đầu vào đáng tin cậy.
- Ở nơi các khung bị cô lập hoàn toàn, hãy truyền sự đồng ý một cách tường minh trên yêu cầu quảng cáo.