This is legacy documentation, and may not be complete. To see the latest documentation, if you are a marketer, refer to the Marketers site. If you are a measurement partner, refer to the Measurement Partners site.
Required. Name of the data access budget. Format: customers/{customerId}/adsDataCustomers/{adsDataCustomerId}/dataAccessBudget e.g. 'customers/123/adsDataCustomers/456/dataAccessBudget'.
Request body
The request body must be empty.
Response body
Data access budget state per date.
If successful, the response body contains data with the following structure:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-18 UTC."],[[["\u003cp\u003eRetrieves the data access budget for the requested ads data source for the last 366 days.\u003c/p\u003e\n"],["\u003cp\u003eUses the \u003ccode\u003eGET\u003c/code\u003e method and requires the \u003ccode\u003ehttps://www.googleapis.com/auth/adsdatahub\u003c/code\u003e authorization scope.\u003c/p\u003e\n"],["\u003cp\u003eProvides the budget state per date, indicating whether it's within the normal level, nearly exhausted, or exhausted.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes a \u003ccode\u003edataDayState\u003c/code\u003e array with objects containing the date and corresponding budget state.\u003c/p\u003e\n"],["\u003cp\u003eThe budget state can be \u003ccode\u003eBUDGET_STATE_ENOUGH_BUDGET\u003c/code\u003e, \u003ccode\u003eBUDGET_STATE_BUDGET_IS_NEARLY_EXHAUSTED\u003c/code\u003e, or \u003ccode\u003eBUDGET_STATE_OUT_OF_BUDGET\u003c/code\u003e.\u003c/p\u003e\n"]]],["The `GET` request to `https://adsdatahub.googleapis.com/v1/{name=customers/*/adsDataCustomers/*/dataAccessBudget}` retrieves data access budget details for the past 366 days, with `name` as a required path parameter. The request body is empty, and the response body includes `dataDayState`, an array of objects containing the budget's state per date. Each `DataDayState` includes `date` and `budgetState`, which can be `BUDGET_STATE_UNSPECIFIED`, `BUDGET_STATE_ENOUGH_BUDGET`, `BUDGET_STATE_BUDGET_IS_NEARLY_EXHAUSTED`, or `BUDGET_STATE_OUT_OF_BUDGET`. Authorization requires the `https://www.googleapis.com/auth/adsdatahub` OAuth scope.\n"],null,["# Method: customers.adsDataCustomers.getDataAccessBudget\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.DataAccessBudget.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [DataDayState](#DataDayState)\n - [JSON representation](#DataDayState.SCHEMA_REPRESENTATION)\n- [BudgetState](#BudgetState)\n\nRetrieves the data access budget for the requested ads data source for the last 366 days.\n\n### HTTP request\n\n`GET https://adsdatahub.googleapis.com/v1/{name=customers/*/adsDataCustomers/*/dataAccessBudget}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. Name of the data access budget. Format: customers/{customerId}/adsDataCustomers/{adsDataCustomerId}/dataAccessBudget e.g. 'customers/123/adsDataCustomers/456/dataAccessBudget'. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nData access budget state per date.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"dataDayState\": [ { object (/ads-data-hub/reference/rest/v1/customers.adsDataCustomers/getDataAccessBudget#DataDayState) } ] } ``` |\n\n| Fields ||\n|------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `dataDayState[]` | `object (`[DataDayState](/ads-data-hub/reference/rest/v1/customers.adsDataCustomers/getDataAccessBudget#DataDayState)`)` Status of the budget by date. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/adsdatahub`\n\nDataDayState\n------------\n\nA record containing date and state of the budget for this date.\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"date\": { object (/ads-data-hub/reference/rest/v1/Date) }, \"budgetState\": enum (/ads-data-hub/reference/rest/v1/customers.adsDataCustomers/getDataAccessBudget#BudgetState) } ``` |\n\n| Fields ||\n|---------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `date` | `object (`[Date](/ads-data-hub/reference/rest/v1/Date)`)` Date of the data day corresponding to this record. |\n| `budgetState` | `enum (`[BudgetState](/ads-data-hub/reference/rest/v1/customers.adsDataCustomers/getDataAccessBudget#BudgetState)`)` State of the budget for this data date. |\n\nBudgetState\n-----------\n\nState of the budget corresponding to a data day.\n\n| Enums ||\n|-------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------|\n| `BUDGET_STATE_UNSPECIFIED` | Default unspecified state, this state is not supposed to appear as the output. |\n| `BUDGET_STATE_ENOUGH_BUDGET` | Budget corresponding to this data day is within the normal level. |\n| `BUDGET_STATE_BUDGET_IS_NEARLY_EXHAUSTED` | Budget corresponding to this data day is close to be exhausted and some query optimization needs to be performed to avoid exhaustion. |\n| `BUDGET_STATE_OUT_OF_BUDGET` | Budget corresponding to this data day is exhausted and queries involving this data day may fail. |"]]