Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

What exactly is action_name? (Maybe) Change its documentation.

Đang mở
  • Có gì không ổn?
#735 0 bình luận 1 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
35/100
Loại issue
Tài liệu
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Công nghệ
javascript
Lĩnh vực
api, documentation

Hướng nghiên cứu

Bắt đầu với tài liệu Tracking HTTP API được trích dẫn và phần triển khai JavaScript được tham chiếu trong js/piwik.js, đặc biệt là logPageView. So sánh cách action_name được mô tả và ghi nhận đối với lượt xem trang và sự kiện, sau đó làm rõ cách sử dụng dự kiến của nó trong tài liệu API bằng một khuyến nghị không mơ hồ và các ví dụ.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

For context: We are currently discussing implementing a tracker solution based on the Tracking HTTP API.

The documentation lists action_name as one of the Recommended parameters. It also states that "you should provide as much information as you can" with regard to the parameters. We understand this as setting the recommended parameters as frequent as possible.

Here is the quoted description of action_name from the documentation:

action_name (recommended) — The title of the action being tracked. For page tracks this is used as page title. If enabled in your installation you may use the category tree structure in this field. For example, “game / register new user” would then create a group “game” and add the item “register new user” in it.

The second sentence of the quote makes it clear to me how to use action_name when tracking page views.

Now, I had a rather long discussion with one of my collegs on how to use action_name when not tracking a page view.
As a Recommended parameter, the documentation kind of suggests to set it in every tracking call if possible, but only gives advice on what to set it to when tracking page views.

Now, I view action_name more like a page_name and I only want to set it when tracking page views, while he wants to set it for every tracking call (to the name of the page the action happens on).

To prove my point, I did two things:

  • I reffered to the JavaScript tracking API, which only uses action_name in logPageView. (Side question: Am I correct to treat the JavaScript implementation as a "Tracker Refference Implementation"?)
  • I tracked an event using the event paramters e_c and e_a, and also set an action_name; The event was logged and I inspected the Matomo database directly, but found out that action_name for the event was recorded nowhere.

He on the other hand argued that:

  • The documentation recommends it, so we should set it.
  • Setting a parameter that might not be used doesn't hurt.

Since we could not come to an agreement on this matter, we are now asking what exactly action_name is and how/when we should use it?

Ngôn ngữ chính
PHP
Star
58
Fork
88
Merge trung bình
6 giờ 29 phút
Pull request đã merge (30 ngày)
3

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của matomo-org/developer-documentation

Tất cả issue của matomo-org/developer-documentation

Issue tương tự

Thêm issue về PHP

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.