Method: postalCodes.get

  • This page details how to get a single postal code by its ID using an HTTP GET request.

  • The request requires a user profile ID and the specific postal code ID as path parameters in the URL.

  • The HTTP request body must be empty, and a successful response contains an instance of a PostalCode.

  • Authorization for this request is granted through the https://www.googleapis.com/auth/dfatrafficking OAuth scope.

Gets one postal code by ID.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
profileId

string (int64 format)

User profile ID associated with this request.
code

string

Postal code ID.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of PostalCode.

Authorization scopes

Requires the following OAuth scope:

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