Reference documentation and code samples for the Google Ads Data Manager V1 Client class PartnerLinkServiceClient.
Service Description: Service for managing partner links.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.
Namespace
Google \ Ads \ DataManager \ V1 \ ClientMethods
__construct
Constructor.
options
array| Google\ApiCore\Options\ClientOptions
Optional. Options for configuring the service API wrapper.
↳ apiEndpoint
string
The address of the API remote host. May optionally include the port, formatted as "
↳ credentials
FetchAuthTokenInterface|CredentialsWrapper
This option should only be used with a pre-constructed Google\Auth\FetchAuthTokenInterface
or Google\ApiCore\CredentialsWrapper
object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. Important: If you are providing a path to a credentials file, or a decoded credentials file as a PHP array, this usage is now DEPRECATED. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. It is recommended to create the credentials explicitly use Google\Auth\Credentials\ServiceAccountCredentials; use Google\Ads\DataManager\V1\PartnerLinkServiceClient; $creds = new ServiceAccountCredentials($scopes, $json); $options = new PartnerLinkServiceClient(['credentials' => $creds]);
https://cloud.google.com/docs/authentication/external/externally-sourced-credentials
↳ credentialsConfig
array
Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
↳ disableRetries
bool
Determines whether or not retries defined by the client configuration should be disabled. Defaults to false
.
↳ clientConfig
string|array
Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
↳ transport
string|TransportInterface
The transport used for executing network requests. May be either the string rest
or grpc
. Defaults to grpc
if gRPC support is detected on the system. Advanced usage
: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface
object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
↳ transportConfig
array
Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
↳ clientCertSource
callable
A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.
↳ logger
false|LoggerInterface
A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag
↳ universeDomain
string
The service domain for the client. Defaults to 'googleapis.com'.
createPartnerLink
Creates a partner link for the 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}
The async variant is PartnerLinkServiceClient::createPartnerLinkAsync() .
request
Google\Ads\DataManager\V1\CreatePartnerLinkRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
use Google\Ads\DataManager\V1\Client\PartnerLinkServiceClient;
use Google\Ads\DataManager\V1\CreatePartnerLinkRequest;
use Google\Ads\DataManager\V1\PartnerLink;
use Google\Ads\DataManager\V1\ProductAccount;
use Google\ApiCore\ApiException;
/**
* @param string $formattedParent The parent, which owns this collection of partner links.
* Format: accountTypes/{account_type}/accounts/{account}
* Please see {@see PartnerLinkServiceClient::accountName()} for help formatting this field.
* @param string $partnerLinkOwningAccountAccountId The ID of the account. For example, your Google Ads account ID.
* @param string $partnerLinkPartnerAccountAccountId The ID of the account. For example, your Google Ads account ID.
*/
function create_partner_link_sample(
string $formattedParent,
string $partnerLinkOwningAccountAccountId,
string $partnerLinkPartnerAccountAccountId
): void {
// Create a client.
$partnerLinkServiceClient = new PartnerLinkServiceClient();
// Prepare the request message.
$partnerLinkOwningAccount = (new ProductAccount())
->setAccountId($partnerLinkOwningAccountAccountId);
$partnerLinkPartnerAccount = (new ProductAccount())
->setAccountId($partnerLinkPartnerAccountAccountId);
$partnerLink = (new PartnerLink())
->setOwningAccount($partnerLinkOwningAccount)
->setPartnerAccount($partnerLinkPartnerAccount);
$request = (new CreatePartnerLinkRequest())
->setParent($formattedParent)
->setPartnerLink($partnerLink);
// Call the API and handle any network failures.
try {
/** @var PartnerLink $response */
$response = $partnerLinkServiceClient->createPartnerLink($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = PartnerLinkServiceClient::accountName('[ACCOUNT_TYPE]', '[ACCOUNT]');
$partnerLinkOwningAccountAccountId = '[ACCOUNT_ID]';
$partnerLinkPartnerAccountAccountId = '[ACCOUNT_ID]';
create_partner_link_sample(
$formattedParent,
$partnerLinkOwningAccountAccountId,
$partnerLinkPartnerAccountAccountId
);
}
deletePartnerLink
Deletes a partner link for the 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}
The async variant is PartnerLinkServiceClient::deletePartnerLinkAsync() .
request
Google\Ads\DataManager\V1\DeletePartnerLinkRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
use Google\Ads\DataManager\V1\Client\PartnerLinkServiceClient;
use Google\Ads\DataManager\V1\DeletePartnerLinkRequest;
use Google\ApiCore\ApiException;
/**
* @param string $formattedName The resource name of the partner link to delete.
* Format:
* accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link}
* Please see {@see PartnerLinkServiceClient::partnerLinkName()} for help formatting this field.
*/
function delete_partner_link_sample(string $formattedName): void
{
// Create a client.
$partnerLinkServiceClient = new PartnerLinkServiceClient();
// Prepare the request message.
$request = (new DeletePartnerLinkRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
$partnerLinkServiceClient->deletePartnerLink($request);
printf('Call completed successfully.' . PHP_EOL);
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = PartnerLinkServiceClient::partnerLinkName(
'[ACCOUNT_TYPE]',
'[ACCOUNT]',
'[PARTNER_LINK]'
);
delete_partner_link_sample($formattedName);
}
searchPartnerLinks
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}
The async variant is PartnerLinkServiceClient::searchPartnerLinksAsync() .
request
Google\Ads\DataManager\V1\SearchPartnerLinksRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
use Google\Ads\DataManager\V1\Client\PartnerLinkServiceClient;
use Google\Ads\DataManager\V1\PartnerLink;
use Google\Ads\DataManager\V1\SearchPartnerLinksRequest;
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
/**
* @param string $formattedParent 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 {@see PartnerLinkServiceClient::accountName()} for help formatting this field.
*/
function search_partner_links_sample(string $formattedParent): void
{
// Create a client.
$partnerLinkServiceClient = new PartnerLinkServiceClient();
// Prepare the request message.
$request = (new SearchPartnerLinksRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $partnerLinkServiceClient->searchPartnerLinks($request);
/** @var PartnerLink $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = PartnerLinkServiceClient::accountName('[ACCOUNT_TYPE]', '[ACCOUNT]');
search_partner_links_sample($formattedParent);
}
createPartnerLinkAsync
optionalArgs
array
deletePartnerLinkAsync
optionalArgs
array
searchPartnerLinksAsync
optionalArgs
array
static::accountName
Formats a string containing the fully-qualified path to represent a account resource.
accountType
string
account
string
string
static::partnerLinkName
Formats a string containing the fully-qualified path to represent a partner_link resource.
accountType
string
account
string
partnerLink
string
string
static::parseName
Parses a formatted name string and returns an associative array of the components in the name.
The following name formats are supported: Template: Pattern
- account: accountTypes/{account_type}/accounts/{account}
- partnerLink: accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link}
The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.
formattedName
string
The formatted name string
template
?string
Optional name of template to match
array

