Method: postalCodes.list
Stay organized with collections
Save and categorize content based on your preferences.
Retrieves a list of postal codes.
HTTP request
GET https://dfareporting.googleapis.com/dfareporting/v4/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
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-16 UTC.
[null,null,["Last updated 2024-10-16 UTC."],[[["\u003cp\u003eRetrieves a list of postal codes associated with a specified user profile.\u003c/p\u003e\n"],["\u003cp\u003eThe request is made using an HTTP GET method to a specific endpoint, passing the profile ID as a path parameter.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes a list of postal codes in JSON format, containing details like kind and postal code collection.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires the \u003ccode\u003edfatrafficking\u003c/code\u003e scope within the Google API.\u003c/p\u003e\n"]]],[],null,["# Method: postalCodes.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.PostalCodesListResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nRetrieves a list of postal codes.\n\n### HTTP request\n\n`GET https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/postalCodes`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|---------------|-----------------------------------------------------------------------------------------------------------------------------------|\n| `profile``Id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` User profile ID associated with this request. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nPostal Code postalCodes.list Response\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"postalCodes\": [ { object (/doubleclick-advertisers/rest/v4/postalCodes#PostalCode) } ] } ``` |\n\n| Fields ||\n|-------------------|-----------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Identifies what kind of resource this is. Value: the fixed string `\"dfareporting#postalCodesListResponse\"` . |\n| `postal``Codes[]` | `object (`[PostalCode](/doubleclick-advertisers/rest/v4/postalCodes#PostalCode)`)` Postal code collection. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/dfatrafficking`"]]
