| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame^] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="displayvideo_v1.html">Display & Video 360 API</a> . <a href="displayvideo_v1.advertisers.html">advertisers</a> . <a href="displayvideo_v1.advertisers.invoices.html">invoices</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#close">close()</a></code></p> |
| 79 | <p class="firstline">Close httplib2 connections.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#list">list(advertiserId, issueMonth=None, loiSapinInvoiceType=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">List invoices for an advertiser.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 85 | <p class="firstline">Retrieves the next page of results.</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#lookupInvoiceCurrency">lookupInvoiceCurrency(advertiserId, invoiceMonth=None, x__xgafv=None)</a></code></p> |
| 88 | <p class="firstline">Lookup invoice currency for an advertiser.</p> |
| 89 | <h3>Method Details</h3> |
| 90 | <div class="method"> |
| 91 | <code class="details" id="close">close()</code> |
| 92 | <pre>Close httplib2 connections.</pre> |
| 93 | </div> |
| 94 | |
| 95 | <div class="method"> |
| 96 | <code class="details" id="list">list(advertiserId, issueMonth=None, loiSapinInvoiceType=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| 97 | <pre>List invoices for an advertiser. |
| 98 | |
| 99 | Args: |
| 100 | advertiserId: string, Required. The ID of the advertiser to list invoices for. (required) |
| 101 | issueMonth: string, Required. Month for which invoices are needed in the format YYYYMM. |
| 102 | loiSapinInvoiceType: string, Select type of invoice to query for Loi Sapin advertisers. Otherwise its ignored. |
| 103 | Allowed values |
| 104 | LOI_SAPIN_INVOICE_TYPE_UNSPECIFIED - Value is not specified. |
| 105 | LOI_SAPIN_INVOICE_TYPE_MEDIA - Invoices with Media cost. |
| 106 | LOI_SAPIN_INVOICE_TYPE_PLATFORM - Invoices with Platform fee. |
| 107 | pageSize: integer, Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. |
| 108 | pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of [ListInvoicesResponse.next_page_token] returned from the previous call to `ListInvoice` method. If not specified, the first page of results will be returned. |
| 109 | x__xgafv: string, V1 error format. |
| 110 | Allowed values |
| 111 | 1 - v1 error format |
| 112 | 2 - v2 error format |
| 113 | |
| 114 | Returns: |
| 115 | An object of the form: |
| 116 | |
| 117 | { # Response message for InvoiceService.ListInvoices. |
| 118 | "invoices": [ # The list of invoices. This list will be absent if empty. |
| 119 | { # A single Invoice. |
| 120 | "budgetInvoiceGroupingId": "A String", # Output only. Budget invoice grouping ID associated with the budget segment in the insertion order. |
| 121 | "budgetSummaries": [ # Output only. The list of summarized budget information associated with this invoice. |
| 122 | { # Represents a summarized budget information associated with this invoice. |
| 123 | "externalBudgetId": "A String", # Output only. External budget id. |
| 124 | "preTaxAmountMicros": "A String", # Output only. The pre-tax amount for this budget, in micros of the invoice's currency. For example if currency_code is `USD`, then 1000000 micros is one US dollar. |
| 125 | "prismaCpeCode": { # Google Payments Center supports searching and filtering on the component fields of this code. # Output only. Codes specific to the MediaOcean Prisma tool. |
| 126 | "prismaClientCode": "A String", # The Prisma client code. |
| 127 | "prismaEstimateCode": "A String", # The Prisma estimate code. |
| 128 | "prismaProductCode": "A String", # The Prisma product code. |
| 129 | }, |
| 130 | "taxAmountMicros": "A String", # Output only. The tax amount for this budget, in micros of the invoice's currency. For example if currency_code is `USD`, then 1000000 micros is one US dollar. |
| 131 | "totalAmountMicros": "A String", # Output only. The total amount of charges for this budget, in micros of the invoice's currency. For example if currency_code is `USD`, then 1000000 micros is one US dollar. |
| 132 | }, |
| 133 | ], |
| 134 | "correctedInvoiceId": "A String", # Output only. The originally issued invoice that is being adjusted by this invoice, if applicable. If there is a corrected invoice, the replaced_invoice_ids field will be empty. May appear on invoice PDF as `Reference invoice number`. |
| 135 | "currencyCode": "A String", # Output only. Invoice currency code in ISO 4217 format. |
| 136 | "displayName": "A String", # Output only. Display name of the invoice. |
| 137 | "dueDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Output only. The invoice due date. |
| 138 | "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. |
| 139 | "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. |
| 140 | "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. |
| 141 | }, |
| 142 | "invoiceId": "A String", # Output only. The unique ID of the invoice. |
| 143 | "invoiceType": "A String", # Output only. The type of invoice document. |
| 144 | "issueDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Output only. The date when the invoice was issued. |
| 145 | "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. |
| 146 | "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. |
| 147 | "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. |
| 148 | }, |
| 149 | "name": "A String", # Output only. The resource name of the invoice. |
| 150 | "nonBudgetMicros": "A String", # Output only. The total amount of costs or adjustments not tied to a particular budget, in micros of the invoice's currency. For example if currency_code is `USD`, then 1000000 micros is one US dollar. |
| 151 | "paymentsAccountId": "A String", # Output only. The ID of the payments account the invoice belongs to. Appears on the invoice PDF as `Billing Account Number`. |
| 152 | "paymentsProfileId": "A String", # Output only. The ID of the payments profile the invoice belongs to. Appears on the invoice PDF as `Billing ID`. |
| 153 | "pdfUrl": "A String", # Output only. The URL to download a PDF copy of the invoice. Note that this URL is user specific and requires a valid OAuth 2.0 access token to access. The access token must be provided in an `Authorization: Bearer` HTTP header and be authorized for one of the following scopes: * `https://www.googleapis.com/auth/display-video-mediaplanning` * `https://www.googleapis.com/auth/display-video` The URL will only be usable for 7 days from when the api is called. |
| 154 | "purchaseOrderNumber": "A String", # Output only. Purchase order number associated with the invoice. |
| 155 | "replacedInvoiceIds": [ # Output only. The originally issued invoice(s) that is being cancelled by this invoice, if applicable. If there are any replaced invoices, the corrected_invoice_id field will be empty. May appear on invoice PDF as `Replaced invoice numbers`. Note: There may be multiple replaced invoices due to consolidation of multiple invoices into a single invoice. |
| 156 | "A String", |
| 157 | ], |
| 158 | "serviceDateRange": { # A date range. # Output only. Service start and end dates which are covered by this invoice. |
| 159 | "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`. |
| 160 | "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. |
| 161 | "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. |
| 162 | "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. |
| 163 | }, |
| 164 | "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The lower bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`. |
| 165 | "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. |
| 166 | "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. |
| 167 | "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. |
| 168 | }, |
| 169 | }, |
| 170 | "subtotalAmountMicros": "A String", # Output only. The pre-tax subtotal amount, in micros of the invoice's currency. For example if currency_code is `USD`, then 1000000 micros is one US dollar. |
| 171 | "totalAmountMicros": "A String", # Output only. The invoice total amount, in micros of the invoice's currency. For example if currency_code is `USD`, then 1000000 micros is one US dollar. |
| 172 | "totalTaxAmountMicros": "A String", # Output only. The sum of all taxes in invoice, in micros of the invoice's currency. For example if currency_code is `USD`, then 1000000 micros is one US dollar. |
| 173 | }, |
| 174 | ], |
| 175 | "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the [ListInvoicesRequest.page_token] field in the subsequent call to `ListInvoices` method to retrieve the next page of results. |
| 176 | }</pre> |
| 177 | </div> |
| 178 | |
| 179 | <div class="method"> |
| 180 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 181 | <pre>Retrieves the next page of results. |
| 182 | |
| 183 | Args: |
| 184 | previous_request: The request for the previous page. (required) |
| 185 | previous_response: The response from the request for the previous page. (required) |
| 186 | |
| 187 | Returns: |
| 188 | A request object that you can call 'execute()' on to request the next |
| 189 | page. Returns None if there are no more items in the collection. |
| 190 | </pre> |
| 191 | </div> |
| 192 | |
| 193 | <div class="method"> |
| 194 | <code class="details" id="lookupInvoiceCurrency">lookupInvoiceCurrency(advertiserId, invoiceMonth=None, x__xgafv=None)</code> |
| 195 | <pre>Lookup invoice currency for an advertiser. |
| 196 | |
| 197 | Args: |
| 198 | advertiserId: string, Required. The ID of the advertiser to lookup currency for. (required) |
| 199 | invoiceMonth: string, Month for which currency is needed in the format YYYYMM. If not set Api would return currency based on current settings. |
| 200 | x__xgafv: string, V1 error format. |
| 201 | Allowed values |
| 202 | 1 - v1 error format |
| 203 | 2 - v2 error format |
| 204 | |
| 205 | Returns: |
| 206 | An object of the form: |
| 207 | |
| 208 | { # Response message for InvoiceService.LookupInvoiceCurrency. |
| 209 | "currencyCode": "A String", # Output only. Invoice currency code in ISO 4217 format. |
| 210 | }</pre> |
| 211 | </div> |
| 212 | |
| 213 | </body></html> |