Reference documentation and code samples for the Google Ads Ad Manager V1 Client class ListPartnersRequest.
Request object for ListPartners method.
Generated from protobuf message google.ads.admanager.v1.ListPartnersRequest
Namespace
Google \ Ads \ AdManager \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The parent, which owns this collection of Partners. Format: |
↳ page_size |
int
Optional. The maximum number of Partners to return. The service may return fewer than this value. If unspecified, at most 50 Partners 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 ListPartners call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListPartners 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: * * |
↳ 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
Partners. Format:
networks/{network_code}
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. The parent, which owns this collection of
Partners. Format:
networks/{network_code}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageSize
Optional. The maximum number of Partners to return. The service may return fewer than this value. If unspecified, at most 50 Partners 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 Partners to return. The service may return fewer than this value. If unspecified, at most 50 Partners 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 ListPartners call.
Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListPartners must match the call that provided the page token.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPageToken
Optional. A page token, received from a previous ListPartners call.
Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListPartners 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:
addresscommentcreditStatusdisplayNameemailexternalIdfaxnamephone
| Returns | |
|---|---|
| Type | Description |
string |
|
setFilter
Optional. Expression to filter the response.
See syntax details at https://developers.google.com/ad-manager/api/beta/filters Filterable fields:
addresscommentcreditStatusdisplayNameemailexternalIdfaxnamephone
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOrderBy
Optional. Expression to specify sorting order.
See syntax details at https://developers.google.com/ad-manager/api/beta/filters#order
| Returns | |
|---|---|
| Type | Description |
string |
|
setOrderBy
Optional. Expression to specify sorting order.
See syntax details at https://developers.google.com/ad-manager/api/beta/filters#order
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSkip
Optional. Number of individual resources to skip while paginating.
| Returns | |
|---|---|
| Type | Description |
int |
|
setSkip
Optional. Number of individual resources to skip while paginating.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameter | |
|---|---|
| Name | Description |
parent |
string
Required. The parent, which owns this collection of
Partners. Format:
|
| Returns | |
|---|---|
| Type | Description |
ListPartnersRequest |
|