Google Ads Ad Manager V1 Client - Class ListChildPublishersRequest (0.14.1)

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

Request object for ListChildPublishers method.

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

Namespace

Google \ Ads \ AdManager \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ parent`	`string` Required. The parent, which owns this collection of ChildPublishers. Format: `networks/{network_code}`
`↳ page_size`	`int` Optional. The maximum number of ChildPublishers to return. The service may return fewer than this value. If unspecified, at most 50 ChildPublishers will be returned. The maximum value is 1000; values greater than 1000 will be coerced to 1000.
`↳ page_token`	`string` Optional. A page token, received from a previous ListChildPublishers call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListChildPublishers 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: * * `accountStatus` * * `addressVerificationStatus` * * `approvalStatus` * * `approvedManageAccountRevenueShareMillipercent` * * `childNetwork` * * `delegationType` * * `displayName` * * `email` * * `identityVerificationStatus` * * `invitationStatus` * * `name` * * `parentRevenueShareMillipercent` * * `pendingOnboardingTasks` * * `readinessStatus` * * `sellerId`
`↳ order_by`	`string` Optional. Expression to specify sorting order. See syntax details at https://developers.google.com/ad-manager/api/beta/filters#order
`↳ skip`	`int` Optional. Number of individual resources to skip while paginating.

getParent

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

Returns
Type	Description
`string`

setParent

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPageSize

Optional. The maximum number of ChildPublishers to return. The service may return fewer than this value. If unspecified, at most 50 ChildPublishers will be returned.

The maximum value is 1000; values greater than 1000 will be coerced to 1000.

Returns
Type	Description
`int`

setPageSize

Optional. The maximum number of ChildPublishers to return. The service may return fewer than this value. If unspecified, at most 50 ChildPublishers will be returned.

The maximum value is 1000; values greater than 1000 will be coerced to 1000.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getPageToken

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

When paginating, all other parameters provided to ListChildPublishers must match the call that provided the page token.

Returns
Type	Description
`string`

setPageToken

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

When paginating, all other parameters provided to ListChildPublishers must match the call that provided the page token.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getFilter

Optional. Expression to filter the response.

See syntax details at https://developers.google.com/ad-manager/api/beta/filters Filterable fields:

accountStatus
addressVerificationStatus
approvalStatus
approvedManageAccountRevenueShareMillipercent
childNetwork
delegationType
displayName
email
identityVerificationStatus
invitationStatus
name
parentRevenueShareMillipercent
pendingOnboardingTasks
readinessStatus
sellerId

Returns
Type	Description
`string`

setFilter