Close httplib2 connections.
List invoices for an advertiser.
list_next(previous_request, previous_response)
Retrieves the next page of results.
lookupInvoiceCurrency(advertiserId, invoiceMonth=None, x__xgafv=None)
Lookup invoice currency for an advertiser.
close()
Close httplib2 connections.
list(advertiserId, issueMonth=None, loiSapinInvoiceType=None, pageSize=None, pageToken=None, x__xgafv=None)
List invoices for an advertiser. 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. 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. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format 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. "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. }, ], "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. "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. "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. "A String", ], "serviceDateRange": { # A date range. # Output only. 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. "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, "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`. "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. }, }, "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. }, ], "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. }
list_next(previous_request, previous_response)
Retrieves the next page of results. Args: previous_request: The request for the previous page. (required) previous_response: The response from the request for the previous page. (required) Returns: A request object that you can call 'execute()' on to request the next page. Returns None if there are no more items in the collection.
lookupInvoiceCurrency(advertiserId, invoiceMonth=None, x__xgafv=None)
Lookup invoice currency for an advertiser. 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. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # Response message for InvoiceService.LookupInvoiceCurrency. "currencyCode": "A String", # Output only. Invoice currency code in ISO 4217 format. }