Tài liệu tham khảo về lớp GAI

Tổng quan

lớp cấp cao nhất của Google Analytics trên iOS.

Cung cấp các cơ sở để tạo trình theo dõi và đặt cờ hành vi.

Kế thừa NSObject.

Phương thức thực thể

(mã nhận dạng< GAITracker >)trackerWithName:trackingId:
 Tạo hoặc truy xuất hoạt động triển khai GAITracker với tên và mã theo dõi được chỉ định. Thêm...
 
(mã nhận dạng< GAITracker >)trackerWithTrackingId:
 Tạo hoặc truy xuất hoạt động triển khai GAITracker có tên bằng với mã theo dõi được chỉ định. Thêm...
 
(void) removeTrackerByName:
 Xoá thiết bị theo dõi khỏi từ điển trình theo dõi. Thêm...
 
(void) gửi đi
 Gửi mọi thông tin theo dõi đang chờ xử lý. Thêm...
 
(void) dispatchWithCompletionHandler:
 Điều phối beacon theo dõi tiếp theo trong hàng đợi, gọi completedHandler khi beacon theo dõi đã được gửi (trả về kGAIDispatchGood) hoặc đã xảy ra lỗi (trả về kGAIDispatchError). Thêm...
 

Phương thức lớp

(GAI *)+ sharedInstance
 Tải bản sao được chia sẻ của lớp Google Analytics cho iOS. Thêm...
 

Thuộc tính

id< GAITracker >defaultTracker
 Để thuận tiện, lớp này sẽ hiển thị một thực thể của trình theo dõi mặc định. Thêm...
 
id< GAILogger >logger
 GAILogger dùng. Thêm...
 
CẢM GIÁCoptOut
 Khi điều này đúng, thông tin theo dõi sẽ không được thu thập; các lệnh gọi theo dõi sẽ trở thành không hoạt động. Thêm...
 
Khoảng thời gian NSTimedispatchInterval
 Nếu giá trị này là số dương, thì thông tin theo dõi sẽ được tự động gửi đi mỗi giây deliveryInterval. Thêm...
 
CẢM GIÁCtrackUncaughtExceptions
 Khi bạn đặt chính sách này thành true, SDK sẽ ghi lại trình xử lý ngoại lệ chưa nắm bắt hiện đã được đăng ký, sau đó đăng ký một trình xử lý ngoại lệ chưa nắm bắt để theo dõi các ngoại lệ xảy ra bằng defaultTracker. Thêm...
 
CẢM GIÁCdryRun
 Khi trường này là "CÓ", sẽ không có thông tin theo dõi nào được gửi. Thêm...
 

Tài liệu về phương pháp

+ (GAI *) sharedInstance

Tải bản sao được chia sẻ của lớp Google Analytics cho iOS.

- (id<GAITracker>) trackerWithName: (NSString *) name
mã theo dõi: (NSString *) trackingId

Tạo hoặc truy xuất hoạt động triển khai GAITracker với tên và mã theo dõi được chỉ định.

Nếu trình theo dõi cho tên được chỉ định chưa tồn tại, thì trình theo dõi đó sẽ được tạo và trả về; nếu không, trình theo dõi hiện có sẽ được trả về. Nếu thiết bị theo dõi hiện có cho tên tương ứng có mã theo dõi khác, thì phương pháp này sẽ không thay đổi mã theo dõi đó. Nếu bạn không đặt defaultTracker, nó sẽ được đặt thành thực thể trình theo dõi được trả về tại đây.

Tham số
tênTên của thiết bị theo dõi này. Không được để trống nil hoặc để trống.
trackingIDMã theo dõi cần sử dụng cho trình theo dõi này. Mã này phải có dạng UA-xxxxx-y.
Giá trị trả về
Một GAITracker được liên kết với tên được chỉ định. Thiết bị theo dõi này có thể được dùng để gửi dữ liệu theo dõi đến Google Analytics. Lần đầu tiên phương thức này được gọi bằng một tên cụ thể, trình theo dõi cho tên đó sẽ được trả về và các lệnh gọi tiếp theo có cùng tên sẽ trả về cùng một phiên bản. Bạn không cần giữ lại thiết bị theo dõi vì thư viện sẽ giữ lại thiết bị theo dõi này trong nội bộ.

Nếu xảy ra lỗi hoặc tên không hợp lệ, phương thức này sẽ trả về nil.

- (id<GAITracker>) trackerWithTrackingId: (NSString *) trackingId

Tạo hoặc truy xuất hoạt động triển khai GAITracker có tên bằng với mã theo dõi được chỉ định.

Nếu chưa có trình theo dõi cho tên tương ứng, thì trình theo dõi đó sẽ được tạo và có mã theo dõi được đặt thành |trackingId|, sau đó được trả về; nếu không, trình theo dõi hiện có sẽ được trả về. Nếu thiết bị theo dõi hiện có cho tên tương ứng có mã theo dõi khác, thì phương pháp này sẽ không thay đổi mã theo dõi đó. Nếu bạn không đặt defaultTracker, nó sẽ được đặt thành thực thể trình theo dõi được trả về tại đây.

Tham số
trackingIDMã theo dõi cần sử dụng cho trình theo dõi này. Mã này phải có dạng UA-xxxxx-y. Tên của thiết bị theo dõi sẽ giống với mã theo dõi.
Giá trị trả về
Một GAITracker được liên kết với mã theo dõi được chỉ định. Thiết bị theo dõi này có thể được dùng để gửi dữ liệu theo dõi đến Google Analytics. Lần đầu tiên phương thức này được gọi bằng một mã theo dõi cụ thể, trình theo dõi cho tên tương ứng sẽ được trả về và các lệnh gọi tiếp theo có cùng mã theo dõi sẽ trả về cùng một phiên bản. Bạn không cần giữ lại thiết bị theo dõi vì thư viện sẽ giữ lại thiết bị theo dõi này trong nội bộ.

Nếu xảy ra lỗi hoặc mã theo dõi không hợp lệ, phương thức này sẽ trả về nil.

- (vô hiệu) removeTrackerByName: (NSString *) name

Xoá thiết bị theo dõi khỏi từ điển trình theo dõi.

Nếu đó là trình theo dõi mặc định, hãy xoá cả trình theo dõi mặc định đó.

Tham số
tênTên của thiết bị theo dõi.
– (vô hiệu) gửi

Gửi mọi thông tin theo dõi đang chờ xử lý.

Lưu ý rằng thuộc tính này không ảnh hưởng đến sendInterval và có thể được dùng cùng với việc gửi đi định kỳ.

– (vô hiệu) dispatchWithCompletionHandler: (void(^)(kết quả GAIDispatchResult)) completionHandler

Điều phối beacon theo dõi tiếp theo trong hàng đợi, gọi completedHandler khi beacon theo dõi đã được gửi (trả về kGAIDispatchGood) hoặc đã xảy ra lỗi (trả về kGAIDispatchError).

Nếu không có kết nối mạng hoặc không có dữ liệu để gửi, hàm kGAIDispatchNoData sẽ được trả về.

Lưu ý rằng việc gọi phương thức này có trình xử lý hoàn thành non-nil sẽ tắt tính năng điều phối định kỳ. Bạn có thể kích hoạt lại chế độ điều phối định kỳ bằng cách đặt dispatchInterval thành số dương khi ứng dụng tiếp tục chạy ở chế độ nền.

Việc gọi phương thức này bằng một nil hoànHandler cũng giống như việc gọi lệnh điều phối ở trên.

Bạn có thể sử dụng phương pháp này để tìm nạp dữ liệu ở chế độ nền trong iOS 7.0 trở lên. Bạn nên gọi hàm này khi ứng dụng sắp thoát để bắt đầu gửi mọi thông tin theo dõi chưa được gửi.

Tham số
completionHandlerKhối sẽ chạy sau một yêu cầu điều phối duy nhất. Thông số GAIDispatchResult cho biết việc gửi thành công, có lỗi hay không có lượt truy cập nào để gửi.

Tài liệu về tài sản

- (id<GAITracker>) defaultTracker
(đọc/ghi, không nguyên tử, gán)

Để thuận tiện, lớp này sẽ hiển thị một thực thể của trình theo dõi mặc định.

Thuộc tính này được khởi động cho nil và sẽ được đặt thành trình theo dõi đầu tiên được tạo thực thể trong trackerWithTrackingId:. Thông tin này có thể bị ghi đè như mong muốn.

Theo mặc định, lớp GAITrackedViewController sẽ sử dụng phiên bản của trình theo dõi này.

- trình ghi nhật ký (id<GAILogger>)
(đọc/ghi, không nguyên tử, giữ lại)

GAILogger dùng.

– (BOOL) optOut
(đọc/ghi, không nguyên tử, gán)

Khi điều này đúng, thông tin theo dõi sẽ không được thu thập; các lệnh gọi theo dõi sẽ trở thành không hoạt động.

Khi bạn đặt chính sách này thành true (đúng), thì mọi thông tin đang chờ tải lên sẽ bị xoá. Giá trị của cờ này sẽ được SDK tự động duy trì. Nhà phát triển có thể tuỳ ý sử dụng cờ này để triển khai chế độ cài đặt chọn không sử dụng trong ứng dụng nhằm cho phép người dùng chọn không sử dụng tính năng theo dõi của Google Analytics.

Thuộc tính này được đặt thành NO trong lần đầu tiên sử dụng Google Analytics SDK trên thiết bị và sẽ duy trì sau đó.

– (NSTimeInterval) dispatchInterval
(đọc/ghi, không nguyên tử, gán)

Nếu giá trị này là số dương, thì thông tin theo dõi sẽ được tự động gửi đi mỗi giây deliveryInterval.

Nếu không, thông tin theo dõi phải được gửi theo cách thủ công bằng cách gọi lệnh gọi điều phối.

Theo mặc định, giá trị này được đặt là 120, cho biết thông tin theo dõi phải được gửi tự động 120 giây một lần.

– (BOOL) trackUncaughtExceptions
(đọc/ghi, không nguyên tử, gán)

Khi bạn đặt chính sách này thành true, SDK sẽ ghi lại trình xử lý ngoại lệ chưa nắm bắt hiện đã được đăng ký, sau đó đăng ký một trình xử lý ngoại lệ chưa nắm bắt để theo dõi các ngoại lệ xảy ra bằng defaultTracker.

Nếu defaultTracker không phải là nil, hàm này sẽ theo dõi ngoại lệ trên công cụ theo dõi và cố gắng gửi đi mọi thông tin theo dõi chưa xử lý trong 5 giây. Sau đó, hàm này sẽ gọi trình xử lý ngoại lệ đã đăng ký trước đó, nếu có. Khi bạn đặt lại thành false (sai), trình xử lý ngoại lệ chưa nắm bắt đã đăng ký trước đó sẽ được khôi phục.

– (BOOL) pressRun
(đọc/ghi, không nguyên tử, gán)

Khi trường này là "CÓ", sẽ không có thông tin theo dõi nào được gửi.

Giá trị mặc định là "NO".