Google Ads Ad Manager V1 Client - Class ListCompaniesResponse (0.1.2)

Reference documentation and code samples for the Google Ads Ad Manager V1 Client class ListCompaniesResponse.

Response object for ListCompaniesRequest containing matching Company objects.

Generated from protobuf message google.ads.admanager.v1.ListCompaniesResponse

Namespace

Google \ Ads \ AdManager \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ companies array<Company>

The Company objects from the specified network.
↳ next_page_token string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
↳ total_size int

Total number of Company objects. If a filter was included in the request, this reflects the total number after the filtering is applied. total_size will not 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

getCompanies

The Company objects from the specified network.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setCompanies

The Company objects from the specified network.

Parameter
Name Description
var array<Company>
Returns
Type Description
$this

getNextPageToken

A token, which can be sent as page_token to retrieve the next page.

If this field is omitted, there are no subsequent pages.

Returns
Type Description
string

setNextPageToken

A token, which can be sent as page_token to retrieve the next page.

If this field is omitted, there are no subsequent pages.

Parameter
Name Description
var string
Returns
Type Description
$this

getTotalSize

Total number of Company objects.

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

Returns
Type Description
int

setTotalSize

Total number of Company objects.

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

Parameter
Name Description
var int
Returns
Type Description
$this