WebhookNotification

리소스가 업데이트될 때 Google 애널리틱스 Data API에서 웹훅 서버로 웹훅 알림을 전송하도록 장기 실행 작업 리소스를 구성합니다.

알림 구성에는 비공개 값이 포함되며 GCP 프로젝트에만 표시됩니다. 서로 다른 GCP 프로젝트가 동일한 장기 실행 작업 리소스에 서로 다른 Webhook 알림을 연결할 수 있습니다.

JSON 표현 
{
  "uri": string,
  "channelToken": string
}
필드
uri

string

선택사항입니다. 웹훅 알림을 수신할 웹 주소입니다. 장기 실행 작업 리소스의 상태가 변경될 때 이 주소로 POST 요청이 수신됩니다. POST 요청의 본문에는 장기 실행 작업 리소스의 JSON 버전과 sentTimestamp 필드가 모두 포함됩니다. 전송된 타임스탬프는 요청이 전송된 에포크 이후의 Unix 마이크로초를 지정합니다. 이를 통해 재생된 알림을 식별할 수 있습니다.

URI의 예는 https://us-central1-example-project-id.cloudfunctions.net/example-function-1입니다.

URI는 HTTPS를 사용해야 하며 웹 서버에 유효한 SSL 인증서가 있는 사이트를 가리켜야 합니다. URI의 최대 문자열 길이는 128자(영문 기준)여야 하며 RFC 1738의 허용 목록에 있는 문자만 사용해야 합니다.

웹훅 서버가 알림을 수신하면 5초 이내에 HTTP 응답 상태 코드 200으로 응답해야 합니다.

웹훅 알림을 사용하려면 URI가 필요합니다.

이 Webhook 서버에 대한 요청에는 서비스 계정 google-analytics-audience-export@system.gserviceaccount.com를 인증하는 ID 토큰이 포함됩니다. ID 토큰에 대한 자세한 내용은 https://cloud.google.com/docs/authentication/token-types#id를 참고하세요. Google Cloud Functions의 경우 인증이 필요하도록 함수를 구성할 수 있습니다. Cloud IAM에서 webhook 게시 요청이 Google Cloud Functions 인증을 통과하려면 Cloud Run 호출자 (roles/run.invoker) 및 Cloud Functions 호출자 (roles/cloudfunctions.invoker) 역할에 서비스 계정 권한을 부여해야 합니다. 이 API는 임의의 URI로 웹훅 알림을 보낼 수 있습니다. Google Cloud Functions 이외의 웹훅 서버의 경우 승인 베어러 헤더의 이 ID 토큰은 필요하지 않으면 무시해야 합니다.
channelToken

string

선택사항입니다. 채널 토큰은 임의의 문자열 값이며 최대 문자열 길이는 64자(영문 기준)여야 합니다. 채널 토큰을 사용하면 웹훅 알림의 소스를 확인할 수 있습니다. 이렇게 하면 메일이 스푸핑되는 것을 방지할 수 있습니다. 채널 토큰은 webhook POST 요청의 X-Goog-Channel-Token HTTP 헤더에 지정됩니다.

웹훅 알림을 사용하기 위해 채널 토큰이 필요하지는 않습니다.