Google Ads Data Manager V1 Client - Class SearchPartnerLinksRequest (0.2.0)

Reference documentation and code samples for the Google Ads Data Manager V1 Client class SearchPartnerLinksRequest.

Request to search for PartnerLink resources. Returns a SearchPartnerLinksResponse.

Generated from protobuf message google.ads.datamanager.v1.SearchPartnerLinksRequest

Namespace

Google \ Ads \ DataManager \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. Account to search for partner links. If no filter is specified, all partner links where this account is either the owning_account or partner_account are returned. Format: accountTypes/{account_type}/accounts/{account}
↳ page_size int

The maximum number of partner links to return. The service may return fewer than this value. If unspecified, at most 10 partner links will be returned. The maximum value is 100; values above 100 will be coerced to 100.
↳ page_token string

A page token, received from a previous SearchPartnerLinks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchPartnerLinks must match the call that provided the page token.
↳ filter string

Optional. A filter string. All fields need to be on the left hand side of each condition (for example: partner_link_id = 123456789). Supported operations: - AND - = - != Supported fields: - partner_link_id - owning_account.account_type - owning_account.account_id - partner_account.account_type - partner_account.account_id Example: owning_account.account_type = "GOOGLE_ADS" OR partner_account.account_id = 987654321

getParent

Required. Account to search for partner links. If no filter is specified, all partner links where this account is either the owning_account or partner_account are returned.

Format: accountTypes/{account_type}/accounts/{account}

Returns
Type Description
string

setParent

Required. Account to search for partner links. If no filter is specified, all partner links where this account is either the owning_account or partner_account are returned.

Format: accountTypes/{account_type}/accounts/{account}

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

The maximum number of partner links to return. The service may return fewer than this value.

If unspecified, at most 10 partner links will be returned. The maximum value is 100; values above 100 will be coerced to 100.

Returns
Type Description
int

setPageSize

The maximum number of partner links to return. The service may return fewer than this value.

If unspecified, at most 10 partner links will be returned. The maximum value is 100; values above 100 will be coerced to 100.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

A page token, received from a previous SearchPartnerLinks call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchPartnerLinks must match the call that provided the page token.

Returns
Type Description
string

setPageToken

A page token, received from a previous SearchPartnerLinks call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchPartnerLinks must match the call that provided the page token.

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

Optional. A filter string. All fields need to be on the left hand side of each condition (for example: partner_link_id = 123456789).

Supported operations:

  • AND
  • =
  • != Supported fields:
  • partner_link_id
  • owning_account.account_type
  • owning_account.account_id
  • partner_account.account_type
  • partner_account.account_id Example: owning_account.account_type = "GOOGLE_ADS" OR partner_account.account_id = 987654321
Returns
Type Description
string

setFilter

Optional. A filter string. All fields need to be on the left hand side of each condition (for example: partner_link_id = 123456789).

Supported operations:

  • AND
  • =
  • != Supported fields:
  • partner_link_id
  • owning_account.account_type
  • owning_account.account_id
  • partner_account.account_type
  • partner_account.account_id Example: owning_account.account_type = "GOOGLE_ADS" OR partner_account.account_id = 987654321
Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. Account to search for partner links. If no filter is specified, all partner links where this account is either the owning_account or partner_account are returned.

Format: accountTypes/{account_type}/accounts/{account} Please see PartnerLinkServiceClient::accountName() for help formatting this field.
Returns
Type Description
SearchPartnerLinksRequest