Method: advertisers.invoices.list

특정 월에 광고주에게 게시된 인보이스를 나열합니다.

'파트너' 인보이스 수준의 결제 프로필에서 생성된 인보이스는 이 메서드를 통해 가져올 수 없습니다.

HTTP 요청

GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/invoices

URL은 gRPC 트랜스코딩 문법을 사용합니다.

경로 매개변수

매개변수
advertiserId

string (int64 format)

필수 항목입니다. 인보이스를 나열할 광고주의 ID입니다.

쿼리 매개변수

매개변수
issueMonth

string

인보이스를 나열할 월입니다. 설정하지 않으면 요청에서 이전 달의 인보이스를 가져옵니다.

YYYYMM 형식이어야 합니다.
loiSapinInvoiceType

enum (LoiSapinInvoiceType)

Loi Sapin 광고주에 대해 가져올 인보이스 유형을 선택합니다.

Loi Sapin 광고주에게만 적용됩니다. 그렇지 않으면 무시됩니다.
pageSize

integer

요청한 페이지 크기입니다. 1에서 200 사이여야 합니다. 지정하지 않으면 기본값은 100입니다. 잘못된 값이 지정되면 오류 코드 INVALID_ARGUMENT를 반환합니다.
pageToken

string

서버에서 반환할 결과 페이지를 식별하는 토큰입니다. 일반적으로 이는 invoices.list 메서드에 대한 이전 호출에서 반환된 nextPageToken 값입니다. 지정하지 않으면 결과의 첫 번째 페이지가 반환됩니다.

요청 본문

요청 본문은 비어 있어야 합니다.

응답 본문

성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.

JSON 표현 
{
  "invoices": [
    {
      object (Invoice)
    }
  ],
  "nextPageToken": string
}
필드
invoices[]

object (Invoice)

인보이스 목록입니다.

비어 있으면 이 목록이 없습니다.
nextPageToken

string

결과의 다음 페이지를 검색하는 토큰입니다. 결과의 다음 페이지를 가져오려면 invoices.list 메서드에 대한 후속 호출의 pageToken 필드에 이 값을 전달하세요.

더 이상 반환할 invoices가 없으면 이 토큰이 없습니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/display-video
  • https://www.googleapis.com/auth/display-video-mediaplanning

자세한 내용은 OAuth 2.0 Overview를 참조하세요.

LoiSapinInvoiceType

Loi Sapin 광고주에게 가능한 인보이스 유형입니다.

열거형
LOI_SAPIN_INVOICE_TYPE_UNSPECIFIED 값이 지정되지 않았습니다.
LOI_SAPIN_INVOICE_TYPE_MEDIA 미디어 비용이 포함된 인보이스입니다.
LOI_SAPIN_INVOICE_TYPE_PLATFORM 플랫폼 수수료가 포함된 인보이스

인보이스

단일 인보이스

JSON 표현 
{
  "name": string,
  "invoiceId": string,
  "displayName": string,
  "paymentsProfileId": string,
  "paymentsAccountId": string,
  "issueDate": {
    object (Date)
  },
  "dueDate": {
    object (Date)
  },
  "serviceDateRange": {
    object (DateRange)
  },
  "currencyCode": string,
  "subtotalAmountMicros": string,
  "totalTaxAmountMicros": string,
  "totalAmountMicros": string,
  "purchaseOrderNumber": string,
  "budgetInvoiceGroupingId": string,
  "invoiceType": enum (InvoiceType),
  "correctedInvoiceId": string,
  "replacedInvoiceIds": [
    string
  ],
  "pdfUrl": string,
  "budgetSummaries": [
    {
      object (BudgetSummary)
    }
  ],
  "nonBudgetMicros": string
}
필드
name

string

인보이스의 리소스 이름입니다.
invoiceId

string

인보이스의 고유 ID입니다.
displayName

string

인보이스의 표시 이름입니다.
paymentsProfileId

string

인보이스가 속한 결제 프로필의 ID입니다.

인보이스 PDF에 Billing ID로 표시됩니다.
paymentsAccountId

string

인보이스가 속한 결제 계정의 ID입니다.

인보이스 PDF에 Billing Account Number로 표시됩니다.
issueDate

object (Date)

인보이스가 발행된 날짜입니다.
dueDate

object (Date)

인보이스 기한입니다.
serviceDateRange

object (DateRange)

이 인보이스에 포함된 서비스 시작일 및 종료일입니다.
currencyCode

string

인보이스에 사용된 통화입니다(ISO 4217 형식).
subtotalAmountMicros

string (int64 format)

세전 소계 금액입니다(인보이스 통화의 마이크로 단위).

예를 들어 currencyCode가 USD이면 1000000은 1달러(USD)를 나타냅니다.
totalTaxAmountMicros

string (int64 format)

인보이스에 포함된 모든 세금의 합계입니다(인보이스 통화의 마이크로 단위).

예를 들어 currencyCode가 USD이면 1000000은 1달러(USD)를 나타냅니다.
totalAmountMicros

string (int64 format)

인보이스 통화의 마이크로 단위로 표시된 인보이스 총금액입니다.

예를 들어 currencyCode가 USD이면 1000000은 1달러(USD)를 나타냅니다.
purchaseOrderNumber

string

인보이스와 연결된 구매주문서 번호입니다.
budgetInvoiceGroupingId

string

이 인보이스의 예산 그룹 ID입니다.

이 필드는 해당 결제 프로필의 인보이스 수준이 '예산에 연결된 인보이스 그룹 ID'로 설정된 경우에만 설정됩니다.
invoiceType

enum (InvoiceType)

인보이스 문서 유형입니다.
correctedInvoiceId

string

이 인보이스에 의해 조정되는 원래 인보이스의 ID입니다(해당하는 경우).

인보이스 PDF에 Reference invoice number로 표시될 수 있습니다.

replacedInvoiceIds가 설정된 경우 이 필드는 비어 있습니다.
replacedInvoiceIds[]

string

이 인보이스로 취소되는 원래 발급된 인보이스의 ID입니다(해당하는 경우). 인보이스가 하나의 인보이스로 통합되는 경우 여러 인보이스가 나열될 수 있습니다.

인보이스 PDF에 Replaced invoice numbers으로 표시될 수 있습니다.

correctedInvoiceId가 설정된 경우 이 필드는 비어 있습니다.
pdfUrl

string

인보이스의 PDF 사본을 다운로드할 수 있는 URL입니다.

이 URL은 사용자별이며 액세스하려면 유효한 OAuth 2.0 액세스 토큰이 필요합니다. 액세스 토큰은 Authorization: Bearer HTTP 헤더에 제공되어야 하며 다음 범위 중 하나에 대해 승인되어야 합니다.

  • https://www.googleapis.com/auth/display-video-mediaplanning
  • https://www.googleapis.com/auth/display-video

URL은 이 인보이스 객체를 가져온 후 7일 동안 또는 이 인보이스를 다시 가져올 때까지 유효합니다.
budgetSummaries[]

object (BudgetSummary)

이 인보이스와 연결된 각 예산의 요약 정보 목록입니다.

이 필드는 해당 결제 프로필의 인보이스 세부정보 수준이 '예산 수준 PO'로 설정된 경우에만 설정됩니다.
nonBudgetMicros

string (int64 format)

특정 예산에 연결되지 않은 비용 또는 조정의 총액입니다(인보이스 통화의 1백만 분의 1).

예를 들어 currencyCode가 USD이면 1000000은 1달러(USD)를 나타냅니다.

InvoiceType

가능한 인보이스 유형입니다.

열거형
INVOICE_TYPE_UNSPECIFIED 이 버전에서 지정되지 않았거나 알 수 없습니다.
INVOICE_TYPE_CREDIT 인보이스의 금액이 음수입니다.
INVOICE_TYPE_INVOICE 인보이스의 금액이 양수입니다.

BudgetSummary

개별 캠페인 예산의 요약 정보입니다.

JSON 표현 
{
  "externalBudgetId": string,
  "prismaCpeCode": {
    object (PrismaCpeCode)
  },
  "preTaxAmountMicros": string,
  "taxAmountMicros": string,
  "totalAmountMicros": string
}
필드
externalBudgetId

string

캠페인 예산의 externalBudgetId에 해당합니다. 캠페인 예산에 값이 설정되지 않은 경우 이 필드는 비어 있습니다.
prismaCpeCode

object (PrismaCpeCode)

Mediaocean Prisma 도구의 관련 클라이언트, 제품, 견적 코드입니다.

externalBudgetSource이 EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN인 캠페인 예산에만 적용됩니다.
preTaxAmountMicros

string (int64 format)

세금 전 이 예산으로 청구된 금액의 합계입니다(인보이스 통화의 마이크로 단위).

예를 들어 currencyCode가 USD이면 1000000은 1달러(USD)를 나타냅니다.
taxAmountMicros

string (int64 format)

이 예산의 청구에 적용된 세금 금액입니다(인보이스 통화의 100만분의 1 단위).

예를 들어 currencyCode가 USD이면 1000000은 1달러(USD)를 나타냅니다.
totalAmountMicros

string (int64 format)

인보이스 통화의 마이크로 단위로, 세금을 포함하여 이 예산으로 발생한 총 청구 금액입니다.

예를 들어 currencyCode가 USD이면 1000000은 1달러(USD)를 나타냅니다.