Method: networks.customFields.list

    • The API allows retrieval of a list of CustomField objects using an HTTP GET request.

    • The API requires a parent path parameter to specify the network from which to retrieve the custom fields.

    • Optional query parameters like pageSize , pageToken , filter , orderBy , and skip can be used to refine the list of custom fields returned.

    • The request body for this API call must be empty.

    • The response body contains a list of CustomField objects, a nextPageToken for pagination, and the totalSize of the results.

    API to retrieve a list of CustomField objects.

    HTTP request

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

    Path parameters

    Parameters
    parent

    string

    Required. The parent, which owns this collection of CustomFields. Format: networks/{networkCode}

    Query parameters

    Parameters
    pageSize

    integer

    Optional. The maximum number of CustomFields to return. The service may return fewer than this value. If unspecified, at most 50 CustomFields will be returned. The maximum value is 1000; values greater than 1000 will be coerced to 1000.

    pageToken

    string

    Optional. A page token, received from a previous customFields.list call. Provide this to retrieve the subsequent page.

    When paginating, all other parameters provided to customFields.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

    Filterable fields:

    • dataType

    • description

    • displayName

    • entityType

    • name

    • options.customFieldOptionId

    • options.displayName

    • status

    • visibility

    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 ListCustomFieldsRequest containing matching CustomField objects.

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

    JSON representation 
     { 
 "customFields" 
 : 
 [ 
 { 
 object (  CustomField 
 
) 
 } 
 ] 
 , 
 "nextPageToken" 
 : 
 string 
 , 
 "totalSize" 
 : 
 integer 
 }
    Fields
    customFields[]

    object ( CustomField )

    The CustomField 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 CustomField objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

    totalSize won't 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 one of the following OAuth scopes:

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

    For more information, see the OAuth 2.0 Overview .
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: