REST Resource: properties.audienceLists

리소스: AudienceList

잠재고객 목록은 목록을 만들 때 잠재고객에 포함되어 있는 사용자 목록입니다. 하나의 잠재고객에 각기 다른 날짜에 대해 생성된 여러 잠재고객 목록이 있을 수 있습니다.

JSON 표현 
{
  "name": string,
  "audience": string,
  "audienceDisplayName": string,
  "dimensions": [
    {
      object (AudienceDimension)
    }
  ],
  "creationQuotaTokensCharged": integer,
  "state": enum (State),
  "beginCreatingTime": string,
  "rowCount": integer,
  "errorMessage": string,
  "percentageCompleted": number,
  "recurringAudienceList": string,
  "webhookNotification": {
    object (WebhookNotification)
  }
}
입력란
name

string

출력 전용입니다. 식별자. 생성 중에 할당된 잠재고객 목록 리소스 이름입니다. 이 리소스 이름으로 이 AudienceList를 식별합니다.

형식: properties/{property}/audienceLists/{audienceList}
audience

string

필수 항목입니다. 잠재고객 리소스 이름입니다. 이 리소스 이름은 나열되는 잠재고객을 식별하고 Analytics Data & Admin API 간에 공유됩니다.

형식: properties/{property}/audiences/{audience}
audienceDisplayName

string

출력 전용입니다. 잠재고객을 설명하는 표시 이름입니다. 예: '구매자'.
dimensions[]

object (AudienceDimension)

필수 항목입니다. 쿼리 응답에 요청되고 표시되는 측정기준입니다.
creationQuotaTokensCharged

integer

출력 전용입니다. AudienceList를 만들 때 청구되는 총 할당량 토큰입니다. 토큰 수는 CREATING 상태의 활동을 기반으로 하므로 AudienceList가 ACTIVE 또는 FAILED 상태로 전환되면 청구되는 토큰이 고정됩니다.
state

enum (State)

출력 전용입니다. 이 AudienceList의 현재 상태입니다.
beginCreatingTime

string (Timestamp format)

출력 전용입니다. AudienceLists.create가 호출되고 AudienceList가 CREATING 상태를 시작한 시간입니다.

RFC3339 UTC 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 "2014-10-02T15:01:23Z" 및 "2014-10-02T15:01:23.045123456Z"입니다.
rowCount

integer

출력 전용입니다. AudienceList 결과의 총 행 수입니다.
errorMessage

string

출력 전용입니다. 오류 메시지는 생성 중에 잠재고객 목록이 실패할 때 채워집니다. 이러한 실패의 일반적인 이유는 할당량 소진입니다.
percentageCompleted

number

출력 전용입니다. 이 잠재고객 내보내기의 완료율(0~100)입니다.
recurringAudienceList

string

출력 전용입니다. 이 잠재고객 목록을 만든 반복 잠재고객 목록입니다. 반복 잠재고객 목록은 매일 잠재고객 목록을 만듭니다.

잠재고객 목록을 직접 만든 경우 관련 반복 잠재고객 목록이 없으므로 이 필드는 비어 있게 됩니다.
webhookNotification

object (WebhookNotification)

선택사항입니다. Google Analytics Data API에서 웹훅 서버로 전송될 웹훅 알림을 구성합니다. 웹훅 사용은 선택사항입니다. 사용하지 않는 경우 이 API를 폴링하여 잠재고객 목록을 사용할 준비가 된 시점을 확인해야 합니다. 웹훅을 사용하면 알림을 서버에 전송할 수 있으므로 폴링할 필요가 없습니다.

1~2개의 POST 요청이 웹훅으로 전송됩니다. 첫 번째 POST 요청이 즉시 전송되고 새로 생성된 잠재고객 목록이 생성 중 상태로 표시됩니다. 잠재고객 목록 생성이 완료된 후 (활성 또는 실패 상태) 두 번째 POST 요청이 전송됩니다.

동일한 잠재고객 목록이 연속해서 빠르게 요청되면 캐시에서 두 번째 및 후속 잠재고객 목록이 제공될 수 있습니다. 이 경우 잠재고객 목록 생성 메서드는 이미 활성 상태인 잠재고객 목록을 반환할 수 있습니다. 이 시나리오에서는 하나의 POST 요청만 웹훅으로 전송됩니다.

상태

AudienceList가 현재 이 상태로 존재합니다.

열거형
STATE_UNSPECIFIED 지정되지 않은 상태는 사용되지 않습니다.
CREATING 현재 AudienceList를 만드는 중이며 향후 사용할 수 있습니다. AudienceLists.create 호출 직후에 만들기가 실행됩니다.
ACTIVE AudienceList가 완전히 생성되어 쿼리할 수 있습니다. AudienceList는 요청에서 비동기식으로 활성 상태로 업데이트됩니다. 이 작업은 최초 생성 호출 후 일정 시간 (예: 15분) 후에 발생합니다.
FAILED AudienceList를 만들지 못했습니다. 이 잠재고객 목록을 다시 요청하면 성공할 수도 있습니다.

방법

create

 나중에 검색할 수 있도록 잠재고객 목록을 만듭니다.

exportSheet

 사용자의 잠재고객 목록을 Google 시트로 내보냅니다.

get

 특정 잠재고객 목록에 대한 구성 메타데이터를 가져옵니다.

list

 속성의 모든 잠재고객 목록을 나열합니다.

query

 사용자의 잠재고객 목록을 검색합니다.