실시간 사용자 이벤트 기록

이 페이지에서는 사용자 이벤트를 실시간으로 기록하는 방법을 설명합니다. 미디어 추천에는 사용자 이벤트가 필요합니다. 미디어 추천을 사용하지 않는 경우 사용자 이벤트를 가져올 필요가 없습니다. 하지만 미디어 검색 앱의 경우 사용자 이벤트를 기록하는 것이 좋습니다.

기록할 수 있는 사용자 이벤트 유형은 userEvents 객체의 eventType 필드를 참고하세요. 사용자 이벤트를 처리하면 추천의 품질과 검색 결과의 순위를 개선할 수 있습니다. 클릭률이 높은 결과는 상단에 표시되고 클릭률이 낮은 결과는 하단에 표시됩니다. 아직 가져오지 않은 문서의 사용자 이벤트는 기록하지 않습니다.

여러 데이터 스토어가 연결된 검색 앱을 사용하는 경우 데이터 스토어 수준이 아닌 위치 수준에서 사용자 이벤트를 처리하는 것이 좋습니다. 이를 통해 특정 사용자 이벤트를 연결된 데이터 스토어로 전송할 수 있습니다. 데이터 스토어 수준이 아닌 위치 수준에서 여러 dataStores의 문서가 포함된 사용자 이벤트를 처리하려면 userEvents.write를 참고하세요.

이전 사용자 이벤트를 일괄적으로 가져오려면 이전 사용자 이벤트 가져오기를 참고하세요.

다음과 같은 방법으로 사용자 이벤트를 기록할 수 있습니다.

사용자 이벤트의 JSON 표현은 API 참조의 userEvents를 참고하세요.

시작하기 전에

사용자 이벤트를 가져오기 전에 다음을 실행하세요.

JavaScript 픽셀로 실시간 사용자 이벤트 기록

JavaScript 픽셀로 사용자 이벤트를 기록하려면 다음을 수행하세요.

  1. userEvents.Collect 메서드 호출을 위한 API 키를 만듭니다.
  2. 사용자 이벤트를 수집하는 JavaScript 태그의 예시는 JavaScript 픽셀 예시를 참고하세요.

API 키 만들기

JavaScript 픽셀을 사용하여 사용자의 브라우저에서 사용자 이벤트를 수집하려면 API 키가 필요합니다.

userEvents.Collect 메서드 호출을 위한 API 키를 만들려면 다음 단계를 완료합니다.

  1. Google Cloud 콘솔에서 사용자 인증 정보 페이지로 이동합니다.

    사용자 인증 정보 페이지로 이동

  2. Google Cloud 콘솔 페이지 상단의 프로젝트 드롭다운에서 프로젝트를 선택합니다(프로젝트가 이미 선택되어 있을 수 있음).

  3. 사용자 인증 정보 만들기를 클릭한 후 API 키를 선택합니다. 리퍼러 제한사항을 추가하지 않습니다. 일부 사용자 개인 정보 보호 설정은 리퍼러 URL을 전달하지 않는 것으로 알려져 있습니다.

    • 사용자 이벤트 로깅을 호출할 때 사용할 생성된 API 키를 기록합니다.
  4. 보안 강화를 위해 https://discoveryengine.googleapis.com/*에서 Vertex AI Agent Builder 서비스에 대한 액세스를 제한하려면 API 키에 HTTP 제한을 추가합니다.

JavaScript 픽셀 예시

다음 예시에서는 JavaScript 픽셀을 사용하여 view-item 사용자 이벤트를 기록합니다.

사용자 이벤트의 JSON 표현은 API 참조의 userEvents를 참고하세요.

<script type="text/javascript">
var user_event = {
  "eventType" : "view-item",
  "userPseudoId": "USER_PSEUDO_ID",
  "userInfo": {
      "userId": "USER_ID"
  },
  "attributionToken": "ATTRIBUTION_TOKEN",
  "tagIds": "TAG_ID",
  "documents": [
      {
        "id": "DOCUMENT_ID"
      }
  ]
};

var _gre = _gre || {};
// Credentials for project.
_gre.apiKey = '[API_KEY]';
_gre.logEvent = user_event;
_gre.projectId = 'PROJECT_ID';
_gre.locationId = 'LOCATION_ID';
_gre.dataStoreId = 'DATA_STORE_ID';

(function() {
  var gre = document.createElement('script'); gre.type = 'text/javascript'; gre.async = true;
  gre.src = 'https://www.gstatic.com/discoveryengine/v1beta_event.js';
  var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(gre, s);
})();

</script>

userEvents.write 메서드로 실시간 사용자 이벤트 기록

REST

userEvents.write 메서드를 사용하면 백엔드 서버에서 API로 직접 사용자 이벤트를 보낼 수 있습니다.

사용자 이벤트를 기록하려면 POST 요청을 userEvents.write 메서드로 전송하고 적절한 요청 본문을 제공합니다. 사용자 이벤트의 JSON 표현은 API 참조의 userEvents를 참고하세요.

데이터 스토어가 여러 개인 앱의 경우 위치 수준에서 이벤트를 처리하는 것이 좋습니다. 이 경우 엔드포인트 https://discoveryengine.googleapis.com/v1beta/projects/PROJECT_NUMBER/locations/LOCATION/userEvents:write를 사용합니다.

export GOOGLE_APPLICATION_CREDENTIALS=/tmp/my-key.json
curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     --data "{
         'eventType': 'view-item',
         'userPseudoId': 'visitor0',
         'eventTime': '2020-01-01T03:33:33.000001Z',
         'tagIds': ['321'],
         'attributionToken': 'ABC',
         'attributes': {
            'example_text_attribute': {
              'text': ['text_1', 'text_2']
            },
            'example_number_attribute': {
               'numbers': [3.14, 42, 1.2345]
            }
         },
         'documents': [{
            'id': 'abc'
          }],
         'userInfo': {
           'userId': 'abc',
           'userAgent': 'Mozilla/5.0'
         },
         'pageInfo': {
          'uri': 'http://example',
          'referrerUri': 'http://example',
          'pageViewId': 'currentPageUri'
        }
}" \\
"https://discoveryengine.googleapis.com/v1beta/projects/PROJECT_NUMBER/locations/global/dataStores/DATA_STORE_ID/userEvents:write"

C#

자세한 내용은 Vertex AI Agent Builder C# API 참고 문서를 확인하세요.

Vertex AI Agent Builder에 인증하려면 애플리케이션 기본 사용자 인증 정보를 설정합니다. 자세한 내용은 로컬 개발 환경의 인증 설정을 참조하세요.

using Google.Cloud.DiscoveryEngine.V1;

public sealed partial class GeneratedUserEventServiceClientSnippets
{
    /// <summary>Snippet for WriteUserEvent</summary>
    /// <remarks>
    /// This snippet has been automatically generated and should be regarded as a code template only.
    /// It will require modifications to work:
    /// - It may require correct/in-range values for request initialization.
    /// - It may require specifying regional endpoints when creating the service client as shown in
    ///   https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.
    /// </remarks>
    public void WriteUserEventRequestObject()
    {
        // Create client
        UserEventServiceClient userEventServiceClient = UserEventServiceClient.Create();
        // Initialize request argument(s)
        WriteUserEventRequest request = new WriteUserEventRequest
        {
            ParentAsDataStoreName = DataStoreName.FromProjectLocationDataStore("[PROJECT]", "[LOCATION]", "[DATA_STORE]"),
            UserEvent = new UserEvent(),
            WriteAsync = false,
        };
        // Make the request
        UserEvent response = userEventServiceClient.WriteUserEvent(request);
    }
}

Go

자세한 내용은 Vertex AI Agent Builder Go API 참고 문서를 확인하세요.

Vertex AI Agent Builder에 인증하려면 애플리케이션 기본 사용자 인증 정보를 설정합니다. 자세한 내용은 로컬 개발 환경의 인증 설정을 참조하세요.


package main

import (
	"context"

	discoveryengine "cloud.google.com/go/discoveryengine/apiv1"
	discoveryenginepb "cloud.google.com/go/discoveryengine/apiv1/discoveryenginepb"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := discoveryengine.NewUserEventClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &discoveryenginepb.WriteUserEventRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/discoveryengine/apiv1/discoveryenginepb#WriteUserEventRequest.
	}
	resp, err := c.WriteUserEvent(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

Java

자세한 내용은 Vertex AI Agent Builder Java API 참고 문서를 확인하세요.

Vertex AI Agent Builder에 인증하려면 애플리케이션 기본 사용자 인증 정보를 설정합니다. 자세한 내용은 로컬 개발 환경의 인증 설정을 참조하세요.

import com.google.cloud.discoveryengine.v1.DataStoreName;
import com.google.cloud.discoveryengine.v1.UserEvent;
import com.google.cloud.discoveryengine.v1.UserEventServiceClient;
import com.google.cloud.discoveryengine.v1.WriteUserEventRequest;

public class SyncWriteUserEvent {

  public static void main(String[] args) throws Exception {
    syncWriteUserEvent();
  }

  public static void syncWriteUserEvent() throws Exception {
    // This snippet has been automatically generated and should be regarded as a code template only.
    // It will require modifications to work:
    // - It may require correct/in-range values for request initialization.
    // - It may require specifying regional endpoints when creating the service client as shown in
    // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
    try (UserEventServiceClient userEventServiceClient = UserEventServiceClient.create()) {
      WriteUserEventRequest request =
          WriteUserEventRequest.newBuilder()
              .setParent(
                  DataStoreName.ofProjectLocationDataStoreName(
                          "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                      .toString())
              .setUserEvent(UserEvent.newBuilder().build())
              .setWriteAsync(true)
              .build();
      UserEvent response = userEventServiceClient.writeUserEvent(request);
    }
  }
}

Python

자세한 내용은 Vertex AI Agent Builder Python API 참고 문서를 확인하세요.

Vertex AI Agent Builder에 인증하려면 애플리케이션 기본 사용자 인증 정보를 설정합니다. 자세한 내용은 로컬 개발 환경의 인증 설정을 참조하세요.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import discoveryengine_v1


def sample_write_user_event():
    # Create a client
    client = discoveryengine_v1.UserEventServiceClient()

    # Initialize request argument(s)
    request = discoveryengine_v1.WriteUserEventRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.write_user_event(request=request)

    # Handle the response
    print(response)

Ruby

자세한 내용은 Vertex AI Agent Builder Ruby API 참고 문서를 확인하세요.

Vertex AI Agent Builder에 인증하려면 애플리케이션 기본 사용자 인증 정보를 설정합니다. 자세한 내용은 로컬 개발 환경의 인증 설정을 참조하세요.

require "google/cloud/discovery_engine/v1"

##
# Snippet for the write_user_event call in the UserEventService service
#
# This snippet has been automatically generated and should be regarded as a code
# template only. It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in https://cloud.google.com/ruby/docs/reference.
#
# This is an auto-generated example demonstrating basic usage of
# Google::Cloud::DiscoveryEngine::V1::UserEventService::Client#write_user_event.
#
def write_user_event
  # Create a client object. The client can be reused for multiple calls.
  client = Google::Cloud::DiscoveryEngine::V1::UserEventService::Client.new

  # Create a request. To set request fields, pass in keyword arguments.
  request = Google::Cloud::DiscoveryEngine::V1::WriteUserEventRequest.new

  # Call the write_user_event method.
  result = client.write_user_event request

  # The returned object is of type Google::Cloud::DiscoveryEngine::V1::UserEvent.
  p result
end