Method: accountTypes.accounts.partnerLinks.search

Searches for all partner links to and from a given account.

Authorization Headers:

This method supports the following optional headers to define how the API authorizes access for the request:

  • login-account: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: accountTypes/{loginAccountType}/accounts/{loginAccountId}
  • linked-account: (Optional) The resource name of the account with an established product link to the login-account. Format: accountTypes/{linkedAccountType}/accounts/{linkedAccountId}

HTTP request

GET https://datamanager.googleapis.com/v1/{parent=accountTypes/*/accounts/*}/partnerLinks:search

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

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

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

Query parameters

Parameters
pageSize

integer

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.
pageToken

string

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

When paginating, all other parameters provided to partnerLinks.search 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: partnerLinkId = 123456789).

Supported operations:

  • AND
  • =
  • !=

Supported fields:

  • partnerLinkId
  • owningAccount.account_type
  • owningAccount.account_id
  • partnerAccount.account_type
  • partnerAccount.account_id

Example: owningAccount.account_type = "GOOGLE_ADS" OR partnerAccount.account_id = 987654321

Request body

The request body must be empty.

Response body

Response from the SearchPartnerLinksRequest.

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

JSON representation 
{
  "partnerLinks": [
    {
      object (PartnerLink)
    }
  ],
  "nextPageToken": string
}
Fields
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.

Authorization scopes

Requires the following OAuth scope:

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