Method: customers.adsDataCustomers.getDataAccessBudget

  • This page describes how to retrieve the data access budget for an ads data source for the past 366 days using a GET request.

  • The request uses path parameters to specify the customer and ads data customer IDs, and the request body must be empty.

  • The response body contains the data access budget state for each date in the requested period.

  • The DataDayState object details the date and the BudgetState for that date, indicating whether there is enough budget, if it's nearly exhausted, or out of budget.

  • Accessing this data requires the https://www.googleapis.com/auth/adsdatahub OAuth scope for authorization.

Retrieves the data access budget for the requested ads data source for the last 366 days.

HTTP request

GET https://adsdatahub.googleapis.com/v1/{name=customers/*/adsDataCustomers/*/dataAccessBudget}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

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:

JSON representation 
{
  "dataDayState": [
    {
      object (DataDayState)
    }
  ]
}
Fields
dataDayState[]

object (DataDayState)

Status of the budget by date.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adsdatahub

DataDayState

A record containing date and state of the budget for this date.

JSON representation 
{
  "date": {
    object (Date)
  },
  "budgetState": enum (BudgetState)
}
Fields
date

object (Date)

Date of the data day corresponding to this record.
budgetState

enum (BudgetState)

State of the budget for this data date.

BudgetState

State of the budget corresponding to a data day.

Enums
BUDGET_STATE_UNSPECIFIED Default unspecified state, this state is not supposed to appear as the output.
BUDGET_STATE_ENOUGH_BUDGET Budget corresponding to this data day is within the normal level.
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.
BUDGET_STATE_OUT_OF_BUDGET Budget corresponding to this data day is exhausted and queries involving this data day may fail.