chore: Update discovery artifacts (#1398)
## Deleted keys were detected in the following stable discovery artifacts:
displayvideo v1 https://github.com/googleapis/google-api-python-client/commit/f6b1a8e2d291c2ac9d2ea590101bb3c8c6fbe6cf
## Discovery Artifact Change Summary:
feat(displayvideo): update the api https://github.com/googleapis/google-api-python-client/commit/f6b1a8e2d291c2ac9d2ea590101bb3c8c6fbe6cf
diff --git a/docs/dyn/displayvideo_v1.advertisers.invoices.html b/docs/dyn/displayvideo_v1.advertisers.invoices.html
index d0fb7a8..cd160e0 100644
--- a/docs/dyn/displayvideo_v1.advertisers.invoices.html
+++ b/docs/dyn/displayvideo_v1.advertisers.invoices.html
@@ -79,13 +79,13 @@
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#list">list(advertiserId, issueMonth=None, loiSapinInvoiceType=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
-<p class="firstline">List invoices for an advertiser.</p>
+<p class="firstline">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.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#lookupInvoiceCurrency">lookupInvoiceCurrency(advertiserId, invoiceMonth=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Lookup invoice currency for an advertiser.</p>
+<p class="firstline">Retrieves the invoice currency used by an advertiser in a given month.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
@@ -94,18 +94,18 @@
<div class="method">
<code class="details" id="list">list(advertiserId, issueMonth=None, loiSapinInvoiceType=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
- <pre>List invoices for an advertiser.
+ <pre>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.
Args:
advertiserId: string, Required. The ID of the advertiser to list invoices for. (required)
- issueMonth: string, Required. Month for which invoices are needed in the format YYYYMM.
- loiSapinInvoiceType: string, Select type of invoice to query for Loi Sapin advertisers. Otherwise its ignored.
+ issueMonth: string, 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: string, Select type of invoice to retrieve for Loi Sapin advertisers. Only applicable to Loi Sapin advertisers. Will be ignored otherwise.
Allowed values
LOI_SAPIN_INVOICE_TYPE_UNSPECIFIED - Value is not specified.
LOI_SAPIN_INVOICE_TYPE_MEDIA - Invoices with Media cost.
LOI_SAPIN_INVOICE_TYPE_PLATFORM - Invoices with Platform fee.
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.
- 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.
+ pageToken: string, 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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -114,48 +114,48 @@
Returns:
An object of the form:
- { # Response message for InvoiceService.ListInvoices.
+ {
"invoices": [ # The list of invoices. This list will be absent if empty.
- { # A single Invoice.
- "budgetInvoiceGroupingId": "A String", # Output only. Budget invoice grouping ID associated with the budget segment in the insertion order.
- "budgetSummaries": [ # Output only. The list of summarized budget information associated with this invoice.
- { # Represents a summarized budget information associated with this invoice.
- "externalBudgetId": "A String", # Output only. External budget id.
- "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.
- "prismaCpeCode": { # Google Payments Center supports searching and filtering on the component fields of this code. # Output only. Codes specific to the MediaOcean Prisma tool.
+ { # A single invoice.
+ "budgetInvoiceGroupingId": "A String", # The budget grouping ID for this invoice. This field will only be set if the invoice level of the corresponding billing profile was set to "Budget invoice grouping ID".
+ "budgetSummaries": [ # The list of summarized information for each budget associated with this invoice. This field will only be set if the invoice detail level of the corresponding billing profile was set to "Budget level PO".
+ { # Summarized information of an individual campaign budget.
+ "externalBudgetId": "A String", # Corresponds to the external_budget_id of a campaign budget. If the value is not set in the campaign budget, this field will be empty.
+ "preTaxAmountMicros": "A String", # The sum of charges made under this budget before taxes, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar.
+ "prismaCpeCode": { # Google Payments Center supports searching and filtering on the component fields of this code. # Relevant client, product, and estimate codes from the Mediaocean Prisma tool. Only applicable for campaign budgets with an external_budget_source of EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN.
"prismaClientCode": "A String", # The Prisma client code.
"prismaEstimateCode": "A String", # The Prisma estimate code.
"prismaProductCode": "A String", # The Prisma product code.
},
- "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.
- "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.
+ "taxAmountMicros": "A String", # The amount of tax applied to charges under this budget, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar.
+ "totalAmountMicros": "A String", # The total sum of charges made under this budget, including tax, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar.
},
],
- "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`.
- "currencyCode": "A String", # Output only. Invoice currency code in ISO 4217 format.
- "displayName": "A String", # Output only. Display name of the invoice.
- "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.
+ "correctedInvoiceId": "A String", # The ID of the original invoice being adjusted by this invoice, if applicable. May appear on the invoice PDF as `Reference invoice number`. If replaced_invoice_ids is set, this field will be empty.
+ "currencyCode": "A String", # The currency used in the invoice in ISO 4217 format.
+ "displayName": "A String", # The display name of the invoice.
+ "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`. # The date when the invoice is due.
"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.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
- "invoiceId": "A String", # Output only. The unique ID of the invoice.
- "invoiceType": "A String", # Output only. The type of invoice document.
- "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.
+ "invoiceId": "A String", # The unique ID of the invoice.
+ "invoiceType": "A String", # The type of invoice document.
+ "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`. # The date when the invoice was issued.
"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.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
- "name": "A String", # Output only. The resource name of the invoice.
- "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.
- "paymentsAccountId": "A String", # Output only. The ID of the payments account the invoice belongs to. Appears on the invoice PDF as `Billing Account Number`.
- "paymentsProfileId": "A String", # Output only. The ID of the payments profile the invoice belongs to. Appears on the invoice PDF as `Billing ID`.
- "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.
- "purchaseOrderNumber": "A String", # Output only. Purchase order number associated with the invoice.
- "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.
+ "name": "A String", # The resource name of the invoice.
+ "nonBudgetMicros": "A String", # 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 represents one US dollar.
+ "paymentsAccountId": "A String", # The ID of the payments account the invoice belongs to. Appears on the invoice PDF as `Billing Account Number`.
+ "paymentsProfileId": "A String", # The ID of the payments profile the invoice belongs to. Appears on the invoice PDF as `Billing ID`.
+ "pdfUrl": "A String", # The URL to download a PDF copy of the invoice. 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 be valid for 7 days after retrieval of this invoice object or until this invoice is retrieved again.
+ "purchaseOrderNumber": "A String", # Purchase order number associated with the invoice.
+ "replacedInvoiceIds": [ # The ID(s) of any originally issued invoice that is being cancelled by this invoice, if applicable. Multiple invoices may be listed if those invoices are being consolidated into a single invoice. May appear on invoice PDF as `Replaced invoice numbers`. If corrected_invoice_id is set, this field will be empty.
"A String",
],
- "serviceDateRange": { # A date range. # Output only. Service start and end dates which are covered by this invoice.
+ "serviceDateRange": { # A date range. # The service start and end dates which are covered by this invoice.
"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`.
"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.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
@@ -167,12 +167,12 @@
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
},
- "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.
- "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.
- "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.
+ "subtotalAmountMicros": "A String", # The pre-tax subtotal amount, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar.
+ "totalAmountMicros": "A String", # The invoice total amount, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar.
+ "totalTaxAmountMicros": "A String", # The sum of all taxes in invoice, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar.
},
],
- "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.
+ "nextPageToken": "A String", # 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.
}</pre>
</div>
@@ -192,11 +192,11 @@
<div class="method">
<code class="details" id="lookupInvoiceCurrency">lookupInvoiceCurrency(advertiserId, invoiceMonth=None, x__xgafv=None)</code>
- <pre>Lookup invoice currency for an advertiser.
+ <pre>Retrieves the invoice currency used by an advertiser in a given month.
Args:
advertiserId: string, Required. The ID of the advertiser to lookup currency for. (required)
- invoiceMonth: string, Month for which currency is needed in the format YYYYMM. If not set Api would return currency based on current settings.
+ invoiceMonth: string, Month for which the currency is needed. If not set, the request will return existing currency settings for the advertiser. Must be in the format YYYYMM.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -205,8 +205,8 @@
Returns:
An object of the form:
- { # Response message for InvoiceService.LookupInvoiceCurrency.
- "currencyCode": "A String", # Output only. Invoice currency code in ISO 4217 format.
+ {
+ "currencyCode": "A String", # Currency used by the advertiser in ISO 4217 format.
}</pre>
</div>