This API is in Beta. The Ad Manager SOAP API documentation is available here.
Method: networks.placements.list
API to retrieve a list of Placement objects.
HTTP request
GET https://admanager.googleapis.com/v1/{parent}/placements
Path parameters
| Parameters |
parent |
string
Required. The parent, which owns this collection of Placements. Format: networks/{networkCode}
|
Query parameters
| Parameters |
pageSize |
integer
Optional. The maximum number of Placements to return. The service may return fewer than this value. If unspecified, at most 50 Placements will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
|
pageToken |
string
Optional. A page token, received from a previous placements.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to placements.list must match the call that provided the page token.
|
filter |
string
Optional. Expression to filter the response. See syntax details at https://developers.google.com/ad-manager/api/beta/filters
|
orderBy |
string
Optional. Expression to specify sorting order. See syntax details at https://developers.google.com/ad-manager/api/beta/filters#order
|
skip |
integer
Optional. Number of individual resources to skip while paginating.
|
Request body
The request body must be empty.
Response body
Response object for ListPlacementsRequest containing matching Placement objects.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"placements": [
{
object (Placement)
}
],
"nextPageToken": string,
"totalSize": integer
} |
| Fields |
placements[] |
object (Placement)
The Placement objects from the specified network.
|
nextPageToken |
string
A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.
|
totalSize |
integer
Total number of Placement objects. If a filter was included in the request, this reflects the total number after the filtering is applied. totalSize will not be calculated in the response unless it has been included in a response field mask. The response field mask can be provided to the method by using the URL parameter $fields or fields, or by using the HTTP/gRPC header X-Goog-FieldMask.
For more information, see https://developers.google.com/ad-manager/api/beta/field-masks
|
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/admanager
For more information, see the OAuth 2.0 Overview.
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-09-23 UTC.
[null,null,["Last updated 2024-09-23 UTC."],[[["This API retrieves a list of Placement objects belonging to a specific network within Google Ad Manager."],["Users can filter and sort results, control pagination, and limit the number of Placements returned."],["The response includes Placement objects, a token for retrieving subsequent pages (if applicable), and the total number of Placements."],["Requires authorization using the `https://www.googleapis.com/auth/admanager` OAuth scope."]]],["This API retrieves a list of `Placement` objects via a `GET` request to `https://admanager.googleapis.com/v1/{parent}/placements`. The `parent` path parameter (network code) is required. Optional query parameters include `pageSize` (max 1000), `pageToken` (for pagination), `filter`, `orderBy`, and `skip`. The request body must be empty. The response body contains a list of `Placement` objects, a `nextPageToken` for pagination, and the `totalSize` of placements after applying filters. The request requires the `https://www.googleapis.com/auth/admanager` authorization scope.\n"]]
