Method: metros.list

  • This page details how to retrieve a list of metros using a GET request to a specific URL.

  • The request requires a profileId path parameter to specify the user profile associated with the request.

  • The request body must be empty for this operation.

  • The successful response body contains a JSON object with kind and metros fields, where metros is an array of Metro objects.

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

Retrieves a list of metros.

HTTP request

GET https://dfareporting.googleapis.com/dfareporting/v5/userprofiles/{profileId}/metros

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

Metro metros.list Response

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

JSON representation 
{
  "kind": string,
  "metros": [
    {
      object (Metro)
    }
  ]
}
Fields
kind

string

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

"dfareporting#metrosListResponse"

.
metros[]

object (Metro)

Metro collection.

Authorization scopes

Requires the following OAuth scope:

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