Google Ads Ad Manager V1 Client - Class TeamServiceClient (0.5.0)

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

Service Description: Provides methods for handling Team objects.

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 \ AdManager \ V1 \ Client

Methods

__construct

Constructor.

Parameters
Name	Description
`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\AdManager\V1\TeamServiceClient; $creds = new ServiceAccountCredentials($scopes, $json); $options = new TeamServiceClient(['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. At the moment, supports only `rest`. 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 = [ 'rest' => [...], ]; See the Google\ApiCore\Transport\RestTransport::build() method 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'.

batchActivateTeams

API to batch activate Team objects.

The async variant is TeamServiceClient::batchActivateTeamsAsync() .

Parameters
Name	Description
`request`	`Google\Ads\AdManager\V1\BatchActivateTeamsRequest` 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.

Returns
Type	Description
`Google\Ads\AdManager\V1\BatchActivateTeamsResponse`

Example

use Google\Ads\AdManager\V1\BatchActivateTeamsRequest;
use Google\Ads\AdManager\V1\BatchActivateTeamsResponse;
use Google\Ads\AdManager\V1\Client\TeamServiceClient;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent       Format: `networks/{network_code}`
 *                                      Please see {@see TeamServiceClient::networkName()} for help formatting this field.
 * @param string $formattedNamesElement The resource names of the `Team`s to activate.
 *                                      Format: `networks/{network_code}/teams/{team_id}`
 *                                      Please see {@see TeamServiceClient::teamName()} for help formatting this field.
 */
function batch_activate_teams_sample(string $formattedParent, string $formattedNamesElement): void
{
    // Create a client.
    $teamServiceClient = new TeamServiceClient();

    // Prepare the request message.
    $formattedNames = [$formattedNamesElement,];
    $request = (new BatchActivateTeamsRequest())
        ->setParent($formattedParent)
        ->setNames($formattedNames);

    // Call the API and handle any network failures.
    try {
        /** @var BatchActivateTeamsResponse $response */
        $response = $teamServiceClient->batchActivateTeams($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 = TeamServiceClient::networkName('[NETWORK_CODE]');
    $formattedNamesElement = TeamServiceClient::teamName('[NETWORK_CODE]', '[TEAM]');

    batch_activate_teams_sample($formattedParent, $formattedNamesElement);
}

batchCreateTeams

API to batch create Team objects.

The async variant is TeamServiceClient::batchCreateTeamsAsync() .

Parameters
Name	Description
`request`	`Google\Ads\AdManager\V1\BatchCreateTeamsRequest` 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.

Returns
Type	Description
`Google\Ads\AdManager\V1\BatchCreateTeamsResponse`

Example

use Google\Ads\AdManager\V1\BatchCreateTeamsRequest;
use Google\Ads\AdManager\V1\BatchCreateTeamsResponse;
use Google\Ads\AdManager\V1\Client\TeamServiceClient;
use Google\Ads\AdManager\V1\CreateTeamRequest;
use Google\Ads\AdManager\V1\Team;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent         The parent resource where `Teams` will be created.
 *                                        Format: `networks/{network_code}`
 *                                        The parent field in the CreateTeamRequest must match this
 *                                        field. Please see
 *                                        {@see TeamServiceClient::networkName()} for help formatting this field.
 * @param string $formattedRequestsParent The parent resource where this `Team` will be created.
 *                                        Format: `networks/{network_code}`
 *                                        Please see {@see TeamServiceClient::networkName()} for help formatting this field.
 * @param string $requestsTeamDisplayName The name of the Team. This value has a maximum length of 127
 *                                        characters.
 */
function batch_create_teams_sample(
    string $formattedParent,
    string $formattedRequestsParent,
    string $requestsTeamDisplayName
): void {
    // Create a client.
    $teamServiceClient = new TeamServiceClient();

    // Prepare the request message.
    $requestsTeam = (new Team())
        ->setDisplayName($requestsTeamDisplayName);
    $createTeamRequest = (new CreateTeamRequest())
        ->setParent($formattedRequestsParent)
        ->setTeam($requestsTeam);
    $requests = [$createTeamRequest,];
    $request = (new BatchCreateTeamsRequest())
        ->setParent($formattedParent)
        ->setRequests($requests);

    // Call the API and handle any network failures.
    try {
        /** @var BatchCreateTeamsResponse $response */
        $response = $teamServiceClient->batchCreateTeams($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 = TeamServiceClient::networkName('[NETWORK_CODE]');
    $formattedRequestsParent = TeamServiceClient::networkName('[NETWORK_CODE]');
    $requestsTeamDisplayName = '[DISPLAY_NAME]';

    batch_create_teams_sample($formattedParent, $formattedRequestsParent, $requestsTeamDisplayName);
}

batchDeactivateTeams

API to batch deactivate Team objects.

The async variant is TeamServiceClient::batchDeactivateTeamsAsync() .

Parameters
Name	Description
`request`	`Google\Ads\AdManager\V1\BatchDeactivateTeamsRequest` 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.

Returns
Type	Description
`Google\Ads\AdManager\V1\BatchDeactivateTeamsResponse`

Example

use Google\Ads\AdManager\V1\BatchDeactivateTeamsRequest;
use Google\Ads\AdManager\V1\BatchDeactivateTeamsResponse;
use Google\Ads\AdManager\V1\Client\TeamServiceClient;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent       Format: `networks/{network_code}`
 *                                      Please see {@see TeamServiceClient::networkName()} for help formatting this field.
 * @param string $formattedNamesElement The resource names of the `Team`s to deactivate.
 *                                      Format: `networks/{network_code}/teams/{team_id}`
 *                                      Please see {@see TeamServiceClient::teamName()} for help formatting this field.
 */
function batch_deactivate_teams_sample(
    string $formattedParent,
    string $formattedNamesElement
): void {
    // Create a client.
    $teamServiceClient = new TeamServiceClient();

    // Prepare the request message.
    $formattedNames = [$formattedNamesElement,];
    $request = (new BatchDeactivateTeamsRequest())
        ->setParent($formattedParent)
        ->setNames($formattedNames);

    // Call the API and handle any network failures.
    try {
        /** @var BatchDeactivateTeamsResponse $response */
        $response = $teamServiceClient->batchDeactivateTeams($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 = TeamServiceClient::networkName('[NETWORK_CODE]');
    $formattedNamesElement = TeamServiceClient::teamName('[NETWORK_CODE]', '[TEAM]');

    batch_deactivate_teams_sample($formattedParent, $formattedNamesElement);
}

batchUpdateTeams

API to batch update Team objects.

The async variant is TeamServiceClient::batchUpdateTeamsAsync() .

Parameters
Name	Description
`request`	`Google\Ads\AdManager\V1\BatchUpdateTeamsRequest` 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.

Returns
Type	Description
`Google\Ads\AdManager\V1\BatchUpdateTeamsResponse`

Example

use Google\Ads\AdManager\V1\BatchUpdateTeamsRequest;
use Google\Ads\AdManager\V1\BatchUpdateTeamsResponse;
use Google\Ads\AdManager\V1\Client\TeamServiceClient;
use Google\Ads\AdManager\V1\Team;
use Google\Ads\AdManager\V1\UpdateTeamRequest;
use Google\ApiCore\ApiException;
use Google\Protobuf\FieldMask;

/**
 * @param string $formattedParent         The parent resource where `Teams` will be updated.
 *                                        Format: `networks/{network_code}`
 *                                        The parent field in the UpdateTeamRequest must match this
 *                                        field. Please see
 *                                        {@see TeamServiceClient::networkName()} for help formatting this field.
 * @param string $requestsTeamDisplayName The name of the Team. This value has a maximum length of 127
 *                                        characters.
 */
function batch_update_teams_sample(string $formattedParent, string $requestsTeamDisplayName): void
{
    // Create a client.
    $teamServiceClient = new TeamServiceClient();

    // Prepare the request message.
    $requestsTeam = (new Team())
        ->setDisplayName($requestsTeamDisplayName);
    $requestsUpdateMask = new FieldMask();
    $updateTeamRequest = (new UpdateTeamRequest())
        ->setTeam($requestsTeam)
        ->setUpdateMask($requestsUpdateMask);
    $requests = [$updateTeamRequest,];
    $request = (new BatchUpdateTeamsRequest())
        ->setParent($formattedParent)
        ->setRequests($requests);

    // Call the API and handle any network failures.
    try {
        /** @var BatchUpdateTeamsResponse $response */
        $response = $teamServiceClient->batchUpdateTeams($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 = TeamServiceClient::networkName('[NETWORK_CODE]');
    $requestsTeamDisplayName = '[DISPLAY_NAME]';

    batch_update_teams_sample($formattedParent, $requestsTeamDisplayName);
}

createTeam

API to create a Team object.

The async variant is TeamServiceClient::createTeamAsync() .

Parameters
Name	Description
`request`	`Google\Ads\AdManager\V1\CreateTeamRequest` 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.

Returns
Type	Description
`Google\Ads\AdManager\V1\Team`

Example

use Google\Ads\AdManager\V1\Client\TeamServiceClient;
use Google\Ads\AdManager\V1\CreateTeamRequest;
use Google\Ads\AdManager\V1\Team;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent The parent resource where this `Team` will be created.
 *                                Format: `networks/{network_code}`
 *                                Please see {@see TeamServiceClient::networkName()} for help formatting this field.
 * @param string $teamDisplayName The name of the Team. This value has a maximum length of 127
 *                                characters.
 */
function create_team_sample(string $formattedParent, string $teamDisplayName): void
{
    // Create a client.
    $teamServiceClient = new TeamServiceClient();

    // Prepare the request message.
    $team = (new Team())
        ->setDisplayName($teamDisplayName);
    $request = (new CreateTeamRequest())
        ->setParent($formattedParent)
        ->setTeam($team);

    // Call the API and handle any network failures.
    try {
        /** @var Team $response */
        $response = $teamServiceClient->createTeam($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 = TeamServiceClient::networkName('[NETWORK_CODE]');
    $teamDisplayName = '[DISPLAY_NAME]';

    create_team_sample($formattedParent, $teamDisplayName);
}

getTeam

API to retrieve a Team object.

The async variant is TeamServiceClient::getTeamAsync() .

Parameters
Name	Description
`request`	`Google\Ads\AdManager\V1\GetTeamRequest` 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.

Returns
Type	Description
`Google\Ads\AdManager\V1\Team`

Example

use Google\Ads\AdManager\V1\Client\TeamServiceClient;
use Google\Ads\AdManager\V1\GetTeamRequest;
use Google\Ads\AdManager\V1\Team;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedName The resource name of the Team.
 *                              Format: `networks/{network_code}/teams/{team_id}`
 *                              Please see {@see TeamServiceClient::teamName()} for help formatting this field.
 */
function get_team_sample(string $formattedName): void
{
    // Create a client.
    $teamServiceClient = new TeamServiceClient();

    // Prepare the request message.
    $request = (new GetTeamRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var Team $response */
        $response = $teamServiceClient->getTeam($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
{
    $formattedName = TeamServiceClient::teamName('[NETWORK_CODE]', '[TEAM]');

    get_team_sample($formattedName);
}

listTeams

API to retrieve a list of Team objects.

The async variant is TeamServiceClient::listTeamsAsync() .

Parameters
Name	Description
`request`	`Google\Ads\AdManager\V1\ListTeamsRequest` 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.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

Example

use Google\Ads\AdManager\V1\Client\TeamServiceClient;
use Google\Ads\AdManager\V1\ListTeamsRequest;
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;

/**
 * @param string $formattedParent The parent, which owns this collection of Teams.
 *                                Format: `networks/{network_code}`
 *                                Please see {@see TeamServiceClient::networkName()} for help formatting this field.
 */
function list_teams_sample(string $formattedParent): void
{
    // Create a client.
    $teamServiceClient = new TeamServiceClient();

    // Prepare the request message.
    $request = (new ListTeamsRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $teamServiceClient->listTeams($request);

        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 = TeamServiceClient::networkName('[NETWORK_CODE]');

    list_teams_sample($formattedParent);
}

updateTeam

API to update a Team object.

The async variant is TeamServiceClient::updateTeamAsync() .

Parameters
Name	Description
`request`	`Google\Ads\AdManager\V1\UpdateTeamRequest` 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.

Returns
Type	Description
`Google\Ads\AdManager\V1\Team`

Example

use Google\Ads\AdManager\V1\Client\TeamServiceClient;
use Google\Ads\AdManager\V1\Team;
use Google\Ads\AdManager\V1\UpdateTeamRequest;
use Google\ApiCore\ApiException;
use Google\Protobuf\FieldMask;

/**
 * @param string $teamDisplayName The name of the Team. This value has a maximum length of 127
 *                                characters.
 */
function update_team_sample(string $teamDisplayName): void
{
    // Create a client.
    $teamServiceClient = new TeamServiceClient();

    // Prepare the request message.
    $team = (new Team())
        ->setDisplayName($teamDisplayName);
    $updateMask = new FieldMask();
    $request = (new UpdateTeamRequest())
        ->setTeam($team)
        ->setUpdateMask($updateMask);

    // Call the API and handle any network failures.
    try {
        /** @var Team $response */
        $response = $teamServiceClient->updateTeam($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
{
    $teamDisplayName = '[DISPLAY_NAME]';

    update_team_sample($teamDisplayName);
}

batchActivateTeamsAsync

Parameters
Name	Description
`request`	`Google\Ads\AdManager\V1\BatchActivateTeamsRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Ads\AdManager\V1\BatchActivateTeamsResponse>`

batchCreateTeamsAsync

Parameters
Name	Description
`request`	`Google\Ads\AdManager\V1\BatchCreateTeamsRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Ads\AdManager\V1\BatchCreateTeamsResponse>`

batchDeactivateTeamsAsync

Parameters
Name	Description
`request`	`Google\Ads\AdManager\V1\BatchDeactivateTeamsRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Ads\AdManager\V1\BatchDeactivateTeamsResponse>`

batchUpdateTeamsAsync

Parameters
Name	Description
`request`	`Google\Ads\AdManager\V1\BatchUpdateTeamsRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Ads\AdManager\V1\BatchUpdateTeamsResponse>`

createTeamAsync

Parameters
Name	Description
`request`	`Google\Ads\AdManager\V1\CreateTeamRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Ads\AdManager\V1\Team>`

getTeamAsync

Parameters
Name	Description
`request`	`Google\Ads\AdManager\V1\GetTeamRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Ads\AdManager\V1\Team>`

listTeamsAsync

Parameters
Name	Description
`request`	`Google\Ads\AdManager\V1\ListTeamsRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>`

updateTeamAsync

Parameters
Name	Description
`request`	`Google\Ads\AdManager\V1\UpdateTeamRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Ads\AdManager\V1\Team>`

static::networkName

Formats a string containing the fully-qualified path to represent a network resource.

Parameter
Name	Description
`networkCode`	`string`

Returns
Type	Description
`string`	The formatted network resource.

static::teamName

Formats a string containing the fully-qualified path to represent a team resource.

Parameters
Name	Description
`networkCode`	`string`
`team`	`string`

Returns
Type	Description
`string`	The formatted team resource.

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

network: networks/{network_code}
team: networks/{network_code}/teams/{team}

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.

Parameters
Name	Description
`formattedName`	`string` The formatted name string
`template`	`?string` Optional name of template to match

Returns
Type	Description
`array`	An associative array from name component IDs to component values.

Google Ads Ad Manager V1 Client - Class TeamServiceClient (0.5.0) Stay organized with collections Save and categorize content based on your preferences.

Namespace

Methods

__construct

batchActivateTeams

batchCreateTeams

batchDeactivateTeams

batchUpdateTeams

createTeam

getTeam

listTeams

updateTeam

batchActivateTeamsAsync

batchCreateTeamsAsync

batchDeactivateTeamsAsync

batchUpdateTeamsAsync

createTeamAsync

getTeamAsync

listTeamsAsync

updateTeamAsync

static::networkName

static::teamName

static::parseName

Google Ads Ad Manager V1 Client - Class TeamServiceClient (0.5.0)