ga 명령어 큐 참조

ga() 명령어 큐는 analytics.js 라이브러리를 사용하는 데 필요한 거의 모든 작업을 실행하기 위한 인터페이스를 제공합니다.

자바스크립트 추적 스니펫은 초기 ga() 명령어 큐 함수를 정의하므로 analytics.js 라이브러리가 완전히 로드되기 전에도 사용할 수 있습니다. analytics.js 라이브러리가 로드되는 즉시 명령어 큐의 항목이 수신된 순서대로 실행됩니다. 실행이 완료되면 큐에 푸시된 새 명령어가 즉시 실행됩니다.

추적 스니펫을 최대한 작게 유지하기 위해 ga() 명령어 큐가 여러 형식의 인수를 허용하도록 오버로드됩니다. 이 문서에서는 ga() 명령어 큐 함수를 호출하는 다양한 모든 방법을 설명합니다.

함수 서명
ga(command, [...fields], [fieldsObject])

다음 함수 서명으로 ga() 명령어 큐 함수를 호출하면 라이브러리가 로드된 후 실행 예약되도록 큐에 명령어가 푸시됩니다.

ga(readyCallback)

ga() 명령어 큐 함수를 함수에 전달하여 호출하면 큐의 다음 지점에서 전달된 함수가 실행되도록 예약합니다.

명령어는 analytics.js 라이브러리가 완전히 로드된 후에만 실행되므로 명령어 큐를 함수에 전달하는 가장 일반적인 이유는 analytics.js 라이브러리가 로드되고 준비될 때 콜백으로 사용하기 위함입니다.

큐에 명령어 추가

다음 함수 서명으로 ga() 명령어 큐 함수를 호출하면 라이브러리가 로드된 후 실행 예약되도록 큐에 명령어가 푸시됩니다.

사용

ga(command, [...fields], [fieldsObject])

매개변수

이름 유형 필수 여부 설명
command string

큐에 추가할 명령어를 나타내는 식별자입니다. 식별자는 다음과 같은 세 부분으로 구성됩니다(처음 두 부분은 선택사항임).


[trackerName.][pluginName:]methodName
trackerName 예약된 명령어를 호출할 추적기의 이름입니다. 추적기 이름을 지정하지 않으면 기본 추적기에서 명령어가 호출됩니다.
pluginName 요청된 analytics.js 플러그인의 이름입니다. pluginName이 지정되면 methodName은 플러그인에서 제공하는 메서드여야 합니다.
methodName 실행 예약할 메서드의 이름입니다. 플러그인 이름을 지정하지 않는 경우 이 메서드는 아래 표시된 명령어 메서드 중 하나여야 합니다.
...fields * 아니요 공통 필드를 빠르게 지정하기 위한 하나 이상의 편의 매개변수입니다(선택사항). 허용되는 특정 필드의 수는 호출하는 명령어 메서드에 따라 다릅니다.
fieldsObject Object 아니요

fields 매개변수에 지정되지 않은 나머지 값을 지정하기 위한 객체입니다.

fields 매개변수와 fieldsObject 모두에 필드가 설정된 경우 fieldsObject의 값이 사용됩니다.

개별 필드 문서는 필드 참조를 참고하세요.

개별 명령어의 예는 아래 명령어 메서드 섹션을 참고하세요.

준비된 콜백

ga() 명령어 큐 함수를 함수에 전달하여 호출하면 큐의 다음 지점에서 전달된 함수가 실행되도록 예약합니다.

명령어는 analytics.js 라이브러리가 완전히 로드된 후에만 실행되므로 명령어 큐를 함수에 전달하는 가장 일반적인 이유는 analytics.js 라이브러리가 로드되고 준비될 때 콜백으로 사용하기 위함입니다.

사용

ga(readyCallback)

매개변수

이름 유형 필수 여부 설명
readyCallback Function

라이브러리가 완전히 로드되어 상호작용할 준비가 되었을 때 호출될 콜백 함수입니다. 이 함수는 기본 추적기 객체를 첫 번째 인수로 하여 호출됩니다. 기본 추적기가 생성되지 않은 경우 첫 번째 인수는 undefined입니다.

참고: 콜백 함수가 호출되면 모든 ga 객체 메서드를 사용할 수 있습니다.

// Queues a tracker object for creation.
ga('create', 'UA-XXXXX-Y', 'auto');

// Once the tracker has been created, log the
// client ID to the console.
ga(function(tracker) {
  console.log(tracker.get('clientId'));
});
// Queues a named tracker object for creation.
ga('create', 'UA-XXXXX-Y', 'auto', 'myTracker');

// When there is no default tracker, the first
// argument of the ready callback is `undefined`.
ga(function(tracker) {
  console.log(tracker); // Logs `undefined`.
});

명령어 메서드 세부정보

다음은 ga() 명령어 큐에 전달할 수 있는 모든 메서드 목록입니다(플러그인 메서드 제외).

create

지정된 필드를 사용하여 새 추적기 인스턴스를 만듭니다.

사용

ga('create', [trackingId], [cookieDomain], [name], [fieldsObject]);

매개변수

개별 필드 문서는 필드 참조를 참고하세요.

반환

undefined

// Creates a default tracker for the Property UA-XXXXX-Y
// and uses automatic cookie domain configuration.
ga('create', 'UA-XXXXX-Y', 'auto');
// Creates a tracker with the name "myTracker" for the Property
// UA-XXXXX-Y, sets the cookieDomain to "example.com", and specifies
// a transport mechanism of "beacon".
ga('create', 'UA-XXXXX-Y', 'example.com', 'myTracker', {
  transport: 'beacon'
});

send

Google 애널리틱스로 조회를 전송합니다.

사용

ga('[trackerName.]send', [hitType], [...fields], [fieldsObject]);

전송되는 필드는 ...fields 매개변수 및 fieldsObject에 지정된 값이며 현재 추적기에 저장된 필드와 병합됩니다.

매개변수

...fields 매개변수로 지정할 수 있는 필드는 조회 유형에 따라 다릅니다. 다음 표에는 각 조회 유형에 해당하는 필드가 나와 있습니다. 표시되지 않은 조회 유형의 경우 ...fields 매개변수는 허용되지 않고 fieldsObject만 허용합니다.

조회 유형 ...fields
pageview page
event eventCategory, eventAction, eventLabel, eventValue
social socialNetwork, socialAction, socialTarget
timing timingCategory, timingVar, timingValue, timingLabel

개별 필드 문서는 필드 참조를 참고하세요.

반환

undefined

// Sends a pageview hit.
ga('send', 'pageview');
// Sends an event hit for the tracker named "myTracker" with the
// following category, action, and label, and sets the nonInteraction
// field value to true.
ga('send', 'event', 'link', 'click', 'http://example.com', {
  nonInteraction: true
});

set

추적기 객체에 단일 필드/값 쌍 또는 필드/값 쌍의 그룹을 설정합니다.

사용

// Sets a single field and value.
ga('[trackerName.]set', fieldName, fieldValue);
// Sets a group of field/value pairs.
ga('[trackerName.]set', fieldsObject);

매개변수

개별 필드 문서는 필드 참조를 참고하세요.

반환

undefined

// Sets the page field to "/about.html".
ga('set', 'page', '/about.html');
// Sets the page field to "/about.html" and the title to "About".
ga('set', {
  page: '/about.html',
  title: 'About'
});

require

analytics.js 플러그인이 필요합니다.

사용

ga('[trackerName.]require', pluginName, [pluginOptions]);

매개변수

이름 유형 필수 여부 설명
pluginName string 요청된 플러그인의 이름입니다. 참고: 플러그인이 공식 analytics.js 플러그인이 아닌 경우 페이지의 다른 곳에서 제공해야 합니다.
pluginOptions Object 아니요 인스턴스화 시 플러그인 생성자에 전달되는 초기화 객체입니다.

반환

undefined

// Requires the Enhanced Ecommerce plugin.
ga('require', 'ec');
// Requires the Advertising Features plugin
// named "myTracker" and override its default cookie name.
ga('myTracker.require', 'displayfeatures', {
  cookieName: 'display_features_cookie'
});

provide

analytics.js 플러그인과 ga() 명령어 큐와 함께 사용할 메서드를 제공합니다.

ga('provide', pluginName, pluginConstuctor);

매개변수

이름 유형 필수 여부 설명
pluginName string 제공되는 플러그인의 이름입니다. require 호출에 사용되는 이름과 동일한 이름을 사용해야 합니다.
pluginConstuctor Function 모든 플러그인 로직과 메서드를 제공하는 생성자 함수입니다. 이 생성자는 require 메서드에 지정된 pluginsOptions 객체를 사용하여 호출됩니다.

// Defines a plugin constructor
function MyPlugin(tracker, options) {
  // ...
}

// Provides the plugin for use with the ga() command queue.
ga('provide', 'myplugin', MyPlugin);

remove

추적기 객체를 삭제합니다.

사용

ga('[trackerName.]remove');

// Remove the default tracker.
ga('remove');
// Remove the  tracker named "myTracker".
ga('myTracker.remove');