Method: networks.customFields.batchDeactivate

  • The customFields:batchDeactivate method deactivates a list of CustomField objects.

  • The HTTP request uses the POST method to https://admanager.googleapis.com/v1/{parent}/customFields:batchDeactivate.

  • The request requires a parent path parameter in the format networks/{networkCode}.

  • The request body requires a list of names representing the resource names of the CustomField objects to deactivate.

  • The response body is empty if the operation is successful.

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

Deactivates a list of CustomField objects.

HTTP request

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

Path parameters

Parameters
parent

string

Required. Format: networks/{networkCode}

Request body

The request body contains data with the following structure:

JSON representation
{
  "names": [
    string
  ]
}
Fields
names[]

string

Required. The resource names of the CustomField objects to deactivate. Format: networks/{networkCode}/customFields/{customFieldId}

Response body

If successful, the response body is empty.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.