Method: postalCodes.get

  • This document outlines how to retrieve a single postal code by its ID using a GET request.

  • The HTTP request uses gRPC Transcoding syntax and requires a profile ID and postal code ID as path parameters.

  • The request body must be empty.

  • The response body, if successful, will contain a PostalCode object.

  • This operation requires the https://www.googleapis.com/auth/dfatrafficking OAuth scope for authorization.

Gets one postal code by ID.

HTTP request

GET https://dfareporting.googleapis.com/dfareporting/v4/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