REST Resource: networks.placements

Resource: Placement

The Placement resource.

JSON representation
{
  "name": string,
  "placementId": string,
  "displayName": string,
  "description": string,
  "placementCode": string,
  "status": enum (PlacementStatus),
  "targetedAdUnits": [
    string
  ],
  "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.

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.

targetedAdUnits[]

string

Optional. The resource names of AdUnits that constitute the Placement. Format: "networks/{networkCode}/adUnits/{adUnitId}"

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

Status of the placement.

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

get

API to retrieve a Placement object.

list

API to retrieve a list of Placement objects.