Method: networks.companies.list

  • The API allows retrieval of a list of Company objects from a specified network using an HTTP GET request.

  • The request requires a parent path parameter identifying the network and supports optional query parameters for pagination, filtering, and sorting.

  • The request body must be empty, and the response body contains a list of Company objects, a token for the next page, and the total size.

  • To use this API, the requesting application must have the https://www.googleapis.com/auth/admanager authorization scope.

API to retrieve a list of Company objects.

HTTP request

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

Path parameters

Parameters
parent

string

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

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of Companies to return. The service may return fewer than this value. If unspecified, at most 50 Companies 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 companies.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to companies.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 ListCompaniesRequest containing matching Company objects.

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

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

object (Company)

The Company 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 Company 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 the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.