Method: regions.list

  • This document outlines how to retrieve a list of regions using a GET request to a specified URL.

  • The only required parameter is the profileId, which should be included in the URL path.

  • The request body must be empty.

  • The response body contains a list of region objects within a JSON structure.

  • Authorization requires the https://www.googleapis.com/auth/dfatrafficking OAuth scope.

Retrieves a list of regions.

HTTP request

GET https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/regions

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
profileId

string (int64 format)

User profile ID associated with this request.

Request body

The request body must be empty.

Response body

Region regions.list Response

If successful, the response body contains data with the following structure:

JSON representation 
{
  "kind": string,
  "regions": [
    {
      object (Region)
    }
  ]
}
Fields
kind

string

Identifies what kind of resource this is. Value: the fixed string

"dfareporting#regionsListResponse"

.
regions[]

object (Region)

Region collection.

Authorization scopes

Requires the following OAuth scope:

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