Method: postalCodes.list

  • This API retrieves a list of postal codes.

  • The HTTP request uses a GET method and includes a required profileId path parameter.

  • The request body must be empty.

  • The response body contains a list of postal code objects and a kind field.

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

Retrieves a list of postal codes.

HTTP request

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

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

Postal Code postalCodes.list Response

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

JSON representation 
{
  "kind": string,
  "postalCodes": [
    {
      object (PostalCode)
    }
  ]
}
Fields
kind

string

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

"dfareporting#postalCodesListResponse"

.
postalCodes[]

object (PostalCode)

Postal code collection.

Authorization scopes

Requires the following OAuth scope:

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