REST Resource: networks.placements
Stay organized with collections
Save and categorize content based on your preferences.
Resource: Placement
| JSON representation |
{
"name": string,
"placementId": string,
"targetedAdUnits": [
string
],
"displayName": string,
"description": string,
"placementCode": string,
"status": enum (PlacementStatus),
"updateTime": string
} |
| Fields |
name |
string
Identifier. The resource name of the Placement. Format: networks/{networkCode}/placements/{placementId}
|
placementId |
string (int64 format)
Output only. Placement ID.
|
targetedAdUnits[] |
string
Optional. The resource names of AdUnits that constitute the Placement. Format: "networks/{networkCode}/adUnits/{adUnit}"
|
displayName |
string
Required. The display name of the placement. This attribute has a maximum length of 255 characters.
|
description |
string
Optional. A description of the Placement. This attribute has a maximum length of 65,535 characters.
|
placementCode |
string
Output only. A string used to uniquely identify the Placement for purposes of serving the ad. This attribute is assigned by Google.
|
status |
enum (PlacementStatus)
Output only. The status of the Placement.
|
updateTime |
string (Timestamp format)
Output only. The instant this Placement was last modified. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
|
PlacementStatus
| Enums |
PLACEMENT_STATUS_UNSPECIFIED |
Not specified value. |
ACTIVE |
Stats are collected, user-visible. |
INACTIVE |
No stats collected, not user-visible. |
ARCHIVED |
No stats collected, user-visible. |
Methods |
|
|
API to retrieve a Placement object. |
|
|
API to retrieve a list of Placement objects. |
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 2025-08-20 UTC.
[null,null,["Last updated 2025-08-20 UTC."],[[["\u003cp\u003eThe \u003ccode\u003ePlacement\u003c/code\u003e resource represents a group of ad units and has properties like display name, description, and status.\u003c/p\u003e\n"],["\u003cp\u003ePlacements can have different statuses: \u003ccode\u003eACTIVE\u003c/code\u003e, \u003ccode\u003eINACTIVE\u003c/code\u003e, or \u003ccode\u003eARCHIVED\u003c/code\u003e, impacting their visibility and data collection.\u003c/p\u003e\n"],["\u003cp\u003eYou can manage placements through APIs to retrieve individual placements or lists of placements for your network.\u003c/p\u003e\n"],["\u003cp\u003eEach Placement is identified by a unique \u003ccode\u003eplacementId\u003c/code\u003e and \u003ccode\u003eplacementCode\u003c/code\u003e assigned by Google.\u003c/p\u003e\n"],["\u003cp\u003eTargeted ad units can be associated with a placement, defining where ads will be served within the placement.\u003c/p\u003e\n"]]],["The `Placement` resource contains information about ad placements, including a unique `placementId`, `displayName`, optional `description`, and `placementCode` for ad serving. It also holds the `status` (ACTIVE, INACTIVE, ARCHIVED) and `targetedAdUnits`. The resource's `name` and `updateTime` are also included. Methods are available to `get` a specific placement and `list` multiple placements. The JSON representation is also detailed for this object.\n"],null,["# REST Resource: networks.placements\n\n- [Resource: Placement](#Placement)\n - [JSON representation](#Placement.SCHEMA_REPRESENTATION)\n- [PlacementStatus](#PlacementStatus)\n- [Methods](#METHODS_SUMMARY)\n\nResource: Placement\n-------------------\n\nThe `Placement` resource.\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"placementId\": string, \"targetedAdUnits\": [ string ], \"displayName\": string, \"description\": string, \"placementCode\": string, \"status\": enum (/ad-manager/api/beta/reference/rest/v1/networks.placements#PlacementStatus), \"updateTime\": string } ``` |\n\n| Fields ||\n|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Identifier. The resource name of the `Placement`. Format: `networks/{networkCode}/placements/{placementId}` |\n| `placementId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Output only. `Placement` ID. |\n| `targetedAdUnits[]` | `string` Optional. The resource names of AdUnits that constitute the Placement. Format: \"networks/{networkCode}/adUnits/{adUnit}\" |\n| `displayName` | `string` Required. The display name of the placement. This attribute has a maximum length of 255 characters. |\n| `description` | `string` Optional. A description of the Placement. This attribute has a maximum length of 65,535 characters. |\n| `placementCode` | `string` Output only. A string used to uniquely identify the Placement for purposes of serving the ad. This attribute is assigned by Google. |\n| `status` | `enum (`[PlacementStatus](/ad-manager/api/beta/reference/rest/v1/networks.placements#PlacementStatus)`)` Output only. The status of the Placement. |\n| `updateTime` | `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` Output only. The instant this Placement was last modified. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than \"Z\" are also accepted. Examples: `\"2014-10-02T15:01:23Z\"`, `\"2014-10-02T15:01:23.045123456Z\"` or `\"2014-10-02T15:01:23+05:30\"`. |\n\nPlacementStatus\n---------------\n\nStatus of the placement.\n\n| Enums ||\n|--------------------------------|---------------------------------------|\n| `PLACEMENT_STATUS_UNSPECIFIED` | Not specified value. |\n| `ACTIVE` | Stats are collected, user-visible. |\n| `INACTIVE` | No stats collected, not user-visible. |\n| `ARCHIVED` | No stats collected, user-visible. |\n\n| Methods ------- ||\n|-----------------------------------------------------------------------------|------------------------------------------------|\n| ### [get](/ad-manager/api/beta/reference/rest/v1/networks.placements/get) | API to retrieve a `Placement` object. |\n| ### [list](/ad-manager/api/beta/reference/rest/v1/networks.placements/list) | API to retrieve a list of `Placement` objects. |"]]
