Method: billingProfiles.list
Stay organized with collections
Save and categorize content based on your preferences.
Retrieves a list of billing profiles, possibly filtered. This method supports paging.
HTTP request
GET https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/billingProfiles
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters |
profileId |
string (int64 format)
User profile ID associated with this request.
|
Query parameters
Parameters |
maxResults |
integer
Maximum number of results to return.
|
currency_code |
string
Select only billing profile with currency.
|
subaccountIds[] |
string (int64 format)
Select only billing profile with the specified subaccount.When onlySuggestion is true, only a single subaccountId is supported.
|
status[] |
enum (BillingStatus )
Select only billing profile with the specified status.
|
onlySuggestion |
boolean
Select only billing profile which is suggested for the currencyCode & subaccountId using the Billing Suggestion API.
|
ids[] |
string (int64 format)
Select only billing profile with these IDs.
|
name |
string
Allows searching for billing profiles by name. Wildcards (
*
) are allowed. For example,
"profile*2020"
will return objects with names like
"profile June 2020"
,
"profile April 2020"
, or simply
"profile 2020"
. Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of
"profile"
will match objects with name
"my profile"
,
"profile 2021"
, or simply
"profile"
.
|
pageToken |
string
Value of the
nextPageToken
from the previous result page.
|
sortField |
enum (SortField )
Field by which to sort the list.
|
sortOrder |
enum (SortOrder )
Order of sorted results.
|
Request body
The request body must be empty.
Response body
Billing profile billingProfiles.list Response
If successful, the response body contains data with the following structure:
JSON representation |
{
"kind": string,
"nextPageToken": string,
"billingProfiles": [
{
object (BillingProfile )
}
]
} |
Fields |
kind |
string
Identifies what kind of resource this is. Value: the fixed string
"dfareporting#billingProfilesListResponse"
.
|
nextPageToken |
string
Pagination token to be used for the next list operation.
|
billingProfiles[] |
object (BillingProfile )
Billing profiles collection.
|
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/dfatrafficking
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-10-16 UTC.
[null,null,["Last updated 2024-10-16 UTC."],[[["\u003cp\u003eRetrieves a list of billing profiles, potentially filtered, with support for paging.\u003c/p\u003e\n"],["\u003cp\u003eThe request is a \u003ccode\u003eGET\u003c/code\u003e request to a specific URL, requiring authorization.\u003c/p\u003e\n"],["\u003cp\u003eYou can filter profiles by various parameters like currency, subaccount, status, and name.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes a list of billing profiles and a pagination token for accessing more results.\u003c/p\u003e\n"],["\u003cp\u003eRequires the \u003ccode\u003edfatrafficking\u003c/code\u003e authorization scope for access.\u003c/p\u003e\n"]]],[],null,["# Method: billingProfiles.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.BillingProfilesListResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nRetrieves a list of billing profiles, possibly filtered. This method supports [paging](/doubleclick-advertisers/trafficking_tasks#list).\n\n### HTTP request\n\n`GET https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/billingProfiles`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|---------------|-----------------------------------------------------------------------------------------------------------------------------------|\n| `profile``Id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` User profile ID associated with this request. |\n\n### Query parameters\n\n| Parameters ||\n|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `max``Results` | `integer` Maximum number of results to return. |\n| `currency_``code` | `string` Select only billing profile with currency. |\n| `subaccount``Ids[]` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Select only billing profile with the specified subaccount.When onlySuggestion is true, only a single subaccountId is supported. |\n| `status[]` | `enum (`[BillingStatus](/doubleclick-advertisers/rest/v4/billingProfiles#BillingStatus)`)` Select only billing profile with the specified status. |\n| `only``Suggestion` | `boolean` Select only billing profile which is suggested for the currencyCode \\& subaccountId using the Billing Suggestion API. |\n| `ids[]` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Select only billing profile with these IDs. |\n| `name` | `string` Allows searching for billing profiles by name. Wildcards ( `*` ) are allowed. For example, `\"profile*2020\"` will return objects with names like `\"profile June 2020\"` , `\"profile April 2020\"` , or simply `\"profile 2020\"` . Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of `\"profile\"` will match objects with name `\"my profile\"` , `\"profile 2021\"` , or simply `\"profile\"` . |\n| `page``Token` | `string` Value of the `nextPageToken` from the previous result page. |\n| `sort``Field` | `enum (`[SortField](/doubleclick-advertisers/rest/v4/SortField)`)` Field by which to sort the list. |\n| `sort``Order` | `enum (`[SortOrder](/doubleclick-advertisers/rest/v4/SortOrder)`)` Order of sorted results. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nBilling profile billingProfiles.list Response\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"nextPageToken\": string, \"billingProfiles\": [ { object (/doubleclick-advertisers/rest/v4/billingProfiles#BillingProfile) } ] } ``` |\n\n| Fields ||\n|-----------------------|-----------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Identifies what kind of resource this is. Value: the fixed string `\"dfareporting#billingProfilesListResponse\"` . |\n| `next``Page``Token` | `string` Pagination token to be used for the next list operation. |\n| `billing``Profiles[]` | `object (`[BillingProfile](/doubleclick-advertisers/rest/v4/billingProfiles#BillingProfile)`)` Billing profiles collection. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/dfatrafficking`"]]