Method: networks.placements.batchUpdate

  • The API allows for the batch updating of Placement objects using a POST request.

  • The parent path parameter is required and specifies the network where placements will be updated.

  • The request body contains a list of UpdatePlacementRequest objects, with a maximum of 100 per batch.

  • The response body contains a list of the updated Placement objects.

  • Authorization requires the https://www.googleapis.com/auth/admanager OAuth scope.

API to batch update Placement objects.

HTTP request

POST https://admanager.googleapis.com/v1/{parent}/placements:batchUpdate

Path parameters

Parameters
parent

string

Required. The parent resource where Placements will be updated. Format: networks/{networkCode} The parent field in the UpdatePlacementsRequest must match this field.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "requests": [
    {
      object (UpdatePlacementRequest)
    }
  ]
}
Fields
requests[]

object (UpdatePlacementRequest)

Required. The Placement objects to update. A maximum of 100 objects can be updated in a batch.

Response body

Response object for placements.batchUpdate method.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "placements": [
    {
      object (Placement)
    }
  ]
}
Fields
placements[]

object (Placement)

The Placement objects updated.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/admanager

For more information, see the OAuth 2.0 Overview.

UpdatePlacementRequest

Request object for placements.patch method.

JSON representation 
{
  "placement": {
    object (Placement)
  },
  "updateMask": string
}
Fields
placement

object (Placement)

Required. The Placement to update.

The Placement's name is used to identify the Placement to update. Format: networks/{networkCode}/placements/{placementId}
updateMask

string (FieldMask format)

Required. The list of fields to update.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".