Method: accounts.payments.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists all the payments available for an account.
HTTP request
GET https://adsense.googleapis.com/v2/{parent=accounts/*}/payments
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. The account which owns the collection of payments. Format: accounts/{account}
|
Request body
The request body must be empty.
Response body
Response definition for the payments list rpc.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"payments": [
{
object (Payment)
}
]
} |
| Fields |
payments[] |
object (Payment)
The payments returned in this list response.
|
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/adsense
https://www.googleapis.com/auth/adsense.readonly
Payment
| JSON representation |
{
"name": string,
"date": {
object (Date)
},
"amount": string
} |
| Fields |
name |
string
Output only. Resource name of the payment. Format:
- accounts/{account}/payments/unpaid for unpaid (current) AdSense earnings.
- accounts/{account}/payments/youtube-unpaid for unpaid (current) YouTube earnings.
- accounts/{account}/payments/yyyy-MM-dd for paid AdSense earnings.
- accounts/{account}/payments/youtube-yyyy-MM-dd for paid YouTube earnings.
|
date |
object (Date)
Output only. For paid earnings, the date that the payment was credited. For unpaid earnings, this field is empty. Payment dates are always returned in the billing timezone (America/Los_Angeles).
|
amount |
string
Output only. The amount of unpaid or paid earnings, as a formatted string, including the currency. E.g. "¥1,235 JPY", "$1,234.57", "£87.65".
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-08-21 UTC.
[null,null,["Last updated 2024-08-21 UTC."],[[["\u003cp\u003eLists all the payments, both paid and unpaid, available for an AdSense account.\u003c/p\u003e\n"],["\u003cp\u003eProvides details such as payment date, amount, and resource name for each payment.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with specific OAuth scopes for access.\u003c/p\u003e\n"],["\u003cp\u003eIncludes separate payment information for AdSense and YouTube earnings.\u003c/p\u003e\n"],["\u003cp\u003eAllows retrieval of payment details using a GET request with the account ID as a path parameter.\u003c/p\u003e\n"]]],["This API endpoint retrieves a list of payments for a specified account using a GET request. The URL requires the account ID as a path parameter (`parent`). The request body is empty. A successful response contains a list of `Payment` objects, each with `name`, `date`, and `amount`. Payment information can be formatted for both AdSense and Youtube earnings. Authorization requires either `adsense` or `adsense.readonly` OAuth scopes. The payment object is a resource with information about paid and unpaid earnings.\n"],null,["# Method: accounts.payments.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListPaymentsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Payment](#Payment)\n - [JSON representation](#Payment.SCHEMA_REPRESENTATION)\n- [Try it!](#try-it)\n\nLists all the payments available for an account.\n\n### HTTP request\n\n`GET https://adsense.googleapis.com/v2/{parent=accounts/*}/payments`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|--------------------------------------------------------------------------------------------------|\n| `parent` | `string` Required. The account which owns the collection of payments. Format: accounts/{account} |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse definition for the payments list rpc.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------|\n| ``` { \"payments\": [ { object (/adsense/management/reference/rest/v2/accounts.payments/list#Payment) } ] } ``` |\n\n| Fields ||\n|--------------|-------------------------------------------------------------------------------------------------------------------------------------------|\n| `payments[]` | `object (`[Payment](/adsense/management/reference/rest/v2/accounts.payments/list#Payment)`)` The payments returned in this list response. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/adsense`\n- `\n https://www.googleapis.com/auth/adsense.readonly`\n\nPayment\n-------\n\nRepresentation of an unpaid or paid payment.\n\nSee [Payment timelines for AdSense](https://support.google.com/adsense/answer/7164703) for more information about payments and the [YouTube homepage and payments account](https://support.google.com/adsense/answer/11622510) article for information about dedicated payments accounts for YouTube.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"date\": { object (/adsense/management/reference/rest/v2/Date) }, \"amount\": string } ``` |\n\n| Fields ||\n|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Output only. Resource name of the payment. Format: - accounts/{account}/payments/unpaid for unpaid (current) AdSense earnings. - accounts/{account}/payments/youtube-unpaid for unpaid (current) YouTube earnings. - accounts/{account}/payments/yyyy-MM-dd for paid AdSense earnings. - accounts/{account}/payments/youtube-yyyy-MM-dd for paid YouTube earnings. |\n| `date` | `object (`[Date](/adsense/management/reference/rest/v2/Date)`)` Output only. For paid earnings, the date that the payment was credited. For unpaid earnings, this field is empty. Payment dates are always returned in the billing timezone (America/Los_Angeles). |\n| `amount` | `string` Output only. The amount of unpaid or paid earnings, as a formatted string, including the currency. E.g. \"¥1,235 JPY\", \"$1,234.57\", \"£87.65\". |"]]
