소매업의 이름이 소매업용 Vertex AI Search로 변경됩니다. 새로운 브랜딩이 반영되도록 콘텐츠를 업데이트하는 중입니다.

Vertex AI Search for Retail 인증

이 문서에서는 Vertex AI Search for Retail에 프로그래매틱 방식으로 인증하는 방법을 설명합니다. Vertex AI Search for Retail에 인증하는 방법은 API에 액세스하는 데 사용하는 인터페이스와 코드가 실행되는 환경에 따라 다릅니다.

Google Cloud 인증에 대한 자세한 내용은 인증 개요를 참조하세요.

API 액세스

Vertex AI Search for Retail은 프로그래매틱 액세스를 지원합니다. 다음 방법으로 API에 액세스할 수 있습니다.

클라이언트 라이브러리
REST

클라이언트 라이브러리

Vertex AI Search for Retail 클라이언트 라이브러리는 Vertex AI Search for Retail에 프로그래매틱 방식으로 인증하기 위한 고수준 언어 지원을 제공합니다. Google Cloud API 호출을 인증하기 위해 클라이언트 라이브러리는 애플리케이션 기본 사용자 인증 정보(ADC)를 지원합니다. 라이브러리가 정의된 위치 집합에서 사용자 인증 정보를 찾고 이러한 사용자 인증 정보를 사용하여 API에 대한 요청을 인증합니다. ADC를 사용하면 애플리케이션 코드를 수정할 필요 없이 로컬 개발 또는 프로덕션과 같은 다양한 환경에서 애플리케이션에 사용자 인증 정보를 제공할 수 있습니다.

REST

gcloud CLI 사용자 인증 정보를 사용하거나 애플리케이션 기본 사용자 인증 정보를 사용하여 Vertex AI Search for Retail API에 인증할 수 있습니다. REST 요청 인증에 대한 자세한 내용은 REST를 사용하여 인증을 참조하세요. 사용자 인증 정보 유형은 gcloud CLI 사용자 인증 정보 및 ADC 사용자 인증 정보를 참조하세요.

API 키

API 키를 사용하면 호출자 ID를 확인하지 않고 청구 및 할당량 목적으로 사용되는 API 호출을 프로젝트와 연결할 수 있습니다. API 키는 API 키를 지원하는 API 메서드에서만 사용할 수 있습니다.

Vertex AI Search for Retail은 다음 API 메서드의 API 키를 지원합니다.

userEvents.collect

Vertex AI Search for Retail에서 API 키를 사용하는 방법에 대한 자세한 내용은 API 키 만들기를 참조하세요. API 키 사용에 대한 일반적인 내용은 API 키를 사용하여 인증을 참조하세요.

Vertex AI Search for Retail에 대한 사용자 인증 정보 및 ADC

ADC에 사용자 인증 정보를 제공하는 한 가지 방법은 gcloud CLI를 사용하여 사용자 인증 정보를 사용자 인증 정보 파일에 삽입하는 것입니다. 이 파일은 ADC가 찾을 수 있는 로컬 파일 시스템에 저장됩니다. 그런 다음 ADC는 제공된 사용자 인증 정보를 사용하여 요청을 인증합니다. 이 방법은 종종 로컬 개발에 사용됩니다.

이 방법을 사용할 경우 Vertex AI Search for Retail 인증을 시도할 때 인증 오류가 발생할 수 있습니다. 이 오류 및 해결 방법에 대한 자세한 내용은 사용자 인증 정보가 작동하지 않음을 참조하세요.

Vertex AI Search for Retail 인증 설정

인증 설정 방법은 코드를 실행 중인 환경에 따라 달라집니다.

인증 설정을 위한 가장 일반적인 옵션은 다음과 같습니다. 인증에 대한 추가 옵션 및 자세한 내용은 인증 방법을 참조하세요.

다음 안내를 완료하기 전에 시작하기 전에의 설명대로 Vertex AI Search for Retail 기본 설정을 완료해야 합니다.

로컬 개발 환경용

다음 방법으로 로컬 개발 환경의 사용자 인증 정보를 설정할 수 있습니다.

클라이언트 라이브러리 또는 서드 파티 도구의 사용자 인증 정보
명령줄을 통한 REST 요청의 사용자 인증 정보

클라이언트 라이브러리 또는 서드 파티 도구

로컬 환경에서 애플리케이션 기본 사용자 인증 정보(ADC)를 설정합니다.

Install the Google Cloud CLI, then initialize it by running the following command:
```
gcloud init
```
If you're using a local shell, then create local authentication credentials for your user account:
```
gcloud auth application-default login
```
You don't need to do this if you're using Cloud Shell.
Note: If the gcloud CLI prints a warning that your account doesn't have the serviceusage.services.use permission, then some gcloud CLI commands and client libraries might not work. Ask an administrator to grant you the Service Usage Consumer IAM role (roles/serviceusage.serviceUsageConsumer), then run the following command:
```
gcloud auth application-default set-quota-project PROJECT_ID
```
로그인 화면이 표시됩니다. 로그인하면 사용자 인증 정보는 ADC에서 사용하는 로컬 사용자 인증 정보 파일에 저장됩니다.

로컬 환경에서 ADC 사용에 대한 자세한 내용은 로컬 개발 환경을 참조하세요.

명령줄의 REST 요청

명령줄에서 REST 요청을 수행할 때는 요청을 전송하는 명령어의 일부로 gcloud auth print-access-token을 포함하여 gcloud CLI 사용자 인증 정보를 사용할 수 있습니다.

다음 예시에서는 지정된 프로젝트에 대한 서비스 계정을 나열합니다. REST 요청에도 동일한 패턴을 사용할 수 있습니다.

요청 데이터를 사용하기 전에 다음을 바꿉니다.

PROJECT_ID: Google Cloud 프로젝트 ID

요청을 보내려면 다음 옵션 중 하나를 펼칩니다.

curl(Linux, macOS, Cloud Shell)

다음 명령어를 실행합니다.

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "x-goog-user-project: PROJECT_ID" \
     "https://iam.googleapis.com/v1/projects/PROJECT_ID/serviceAccounts"

PowerShell(Windows)

다음 명령어를 실행합니다.

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred"; "x-goog-user-project" = "PROJECT_ID" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://iam.googleapis.com/v1/projects/PROJECT_ID/serviceAccounts" | Select-Object -Expand Content

REST 및 gRPC를 사용하여 인증하는 방법에 대한 자세한 내용은 REST 사용을 위한 인증을 참조하세요. 로컬 ADC 사용자 인증 정보와 gcloud CLI 사용자 인증 정보의 차이점에 대한 자세한 내용은 gcloud CLI 인증 구성 및 ADC 구성을 참조하세요.

Google Cloud

Google Cloud에서 실행되는 워크로드를 인증하려면 코드가 실행 중인 컴퓨팅 리소스(예: Compute Engine 가상 머신(VM) 인스턴스)에 연결된 서비스 계정의 사용자 인증 정보를 사용합니다. 이 방식은 Google Cloud 컴퓨팅 리소스에서 실행되는 코드에 선호되는 인증 방법입니다.

대부분의 서비스의 경우 코드를 실행할 리소스를 만들 때 서비스 계정을 연결해야 합니다. 이후에는 서비스 계정을 추가하거나 교체할 수 없습니다. 언제든지 VM 인스턴스에 서비스 계정을 연결할 수 있게 해주는 Compute Engine은 예외입니다.

gcloud CLI를 사용하여 서비스 계정을 만들고 리소스에 연결합니다.

Install the Google Cloud CLI, then initialize it by running the following command:
```
gcloud init
```
Set up authentication:
1. Create the service account:
```
gcloud iam service-accounts create SERVICE_ACCOUNT_NAME
```
  Replace SERVICE_ACCOUNT_NAME with a name for the service account.
2. To provide access to your project and your resources, grant a role to the service account:
```
gcloud projects add-iam-policy-binding PROJECT_ID --member="serviceAccount:SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com" --role=ROLE
```
  Replace the following:
  - SERVICE_ACCOUNT_NAME: the name of the service account
  - PROJECT_ID: the project ID where you created the service account
  - ROLE: the role to grant
  Note: The --role flag affects which resources the service account can access in your project. You can revoke these roles or grant additional roles later. In production environments, do not grant the Owner, Editor, or Viewer roles. Instead, grant a predefined role or custom role that meets your needs.
3. To grant another role to the service account, run the command as you did in the previous step.
4. Grant the required role to the principal that will attach the service account to other resources.
```
gcloud iam service-accounts add-iam-policy-binding SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com --member="user:USER_EMAIL" --role=roles/iam.serviceAccountUser
```
  Replace the following:
  - SERVICE_ACCOUNT_NAME: the name of the service account
  - PROJECT_ID: the project ID where you created the service account
  - USER_EMAIL: the email address for a Google Account
코드를 실행할 리소스를 만들고 이 리소스에 서비스 계정을 연결합니다. 예를 들어 Compute Engine을 사용하는 경우 다음 안내를 따르세요.
Create a Compute Engine instance. Configure the instance as follows:
- INSTANCE_NAME을 원하는 인스턴스 이름으로 바꿉니다.
- --zone 플래그를 인스턴스를 만들 영역으로 설정합니다.
- --service-account 플래그를 만든 서비스 계정의 이메일 주소로 설정합니다.

Google API 인증에 대한 자세한 내용은 인증 방법을 참조하세요.

온프레미스 또는 다른 클라우드 제공업체

Google Cloud 외부에서 인증을 설정하는 데 선호되는 방법은 워크로드 아이덴티티 제휴를 사용하는 것입니다. 자세한 내용은 인증 문서에서 온프레미스 또는 다른 클라우드 제공업체를 참조하세요.

Vertex AI Search for Retail 액세스 제어

Vertex AI Search for Retail에 인증한 후에는 Google Cloud 리소스에 액세스할 수 있는 권한이 있어야 합니다. Vertex AI Search for Retail은 승인에 Identity and Access Management(IAM)를 사용합니다.

Vertex AI Search for Retail의 역할에 대한 자세한 내용은 Identity and Access Management(IAM)를 참조하세요. IAM 및 승인에 대한 자세한 내용은 IAM 개요를 참조하세요.

다음 단계

Google Cloud 인증 방법 알아보기
인증 사용 사례 목록 살펴보기