GOgoogle
advertisers

GET /v4/advertisers/{advertisersId}/invoices

Lists invoices posted for an advertiser in a given month. Invoices generated by billing profiles with a "Partner" invoice level are not retrievable through this method.

Request

  • Base URL
    https://displayvideo.googleapis.com
  • Auth
    • OAuth 2 and OAuth 2
      Implicithttps://accounts.google.com/o/oauth2/auth
      Scopeshttps://www.googleapis.com/auth/display-video
      Authorization codehttps://accounts.google.com/o/oauth2/auth
      Token URLhttps://accounts.google.com/o/oauth2/token
      Scopeshttps://www.googleapis.com/auth/display-video
    • or OAuth 2 and OAuth 2
      Implicithttps://accounts.google.com/o/oauth2/auth
      Scopeshttps://www.googleapis.com/auth/display-video-mediaplanning
      Authorization codehttps://accounts.google.com/o/oauth2/auth
      Token URLhttps://accounts.google.com/o/oauth2/token
      Scopeshttps://www.googleapis.com/auth/display-video-mediaplanning
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

advertisersIdstring required

Query parameters

issueMonthstring

The month to list the invoices for. If not set, the request will retrieve invoices for the previous month. Must be in the format YYYYMM.

loiSapinInvoiceType'LOI_SAPIN_INVOICE_TYPE_UNSPECIFIED' | 'LOI_SAPIN_INVOICE_TYPE_MEDIA' | 'LOI_SAPIN_INVOICE_TYPE_PLATFORM'

Select type of invoice to retrieve for Loi Sapin advertisers. Only applicable to Loi Sapin advertisers. Will be ignored otherwise.

pageSizeinteger

Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

pageTokenstring

A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListInvoices method. If not specified, the first page of results will be returned.

Response

Successful response

nextPageTokenstring

A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to ListInvoices method to retrieve the next page of results. This token will be absent if there are no more invoices to return.

Changes

No recorded changes to this operation across all 7 revisions of this API.