Method: networks.customFields.batchUpdate

  • The API uses a POST request to the specified URL for batch updating CustomField objects.

  • The request requires a parent parameter in the URL path, specifying the network where updates will occur.

  • The request body contains a list of UpdateCustomFieldRequest objects, each defining a CustomField to update and a updateMask to specify which fields to modify.

  • The response body returns the updated CustomField objects.

  • The API requires the https://www.googleapis.com/auth/admanager OAuth scope for authorization.

API to batch update CustomField objects.

HTTP request

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

Path parameters

Parameters
parent

string

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

Request body

The request body contains data with the following structure:

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

object (UpdateCustomFieldRequest)

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

Response body

Response object for customFields.batchUpdate method.

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

JSON representation 
{
  "customFields": [
    {
      object (CustomField)
    }
  ]
}
Fields
customFields[]

object (CustomField)

The CustomField objects updated.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.

UpdateCustomFieldRequest

Request object for customFields.patch method.

JSON representation 
{
  "customField": {
    object (CustomField)
  },
  "updateMask": string
}
Fields
customField

object (CustomField)

Required. The CustomField to update.

The CustomField's name is used to identify the CustomField to update.
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".