Google Ads Ad Manager V1 Client - Class SlateServiceClient (0.14.1)

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

Service Description: Provides methods for handling Slate 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`	`Google\Auth\FetchAuthTokenInterface\|Google\ApiCore\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\SlateServiceClient; $creds = new ServiceAccountCredentials($scopes, $json); $options = new SlateServiceClient(['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\|Google\ApiCore\Transport\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\|Psr\Log\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'.

batchArchiveSlates

Batch archives Slate objects.

The async variant is SlateServiceClient::batchArchiveSlatesAsync() .

Parameters
Name	Description
`request`	`Google\Ads\AdManager\V1\BatchArchiveSlatesRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`Google\ApiCore\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\BatchArchiveSlatesResponse`

Example

use Google\Ads\AdManager\V1\BatchArchiveSlatesRequest;
use Google\Ads\AdManager\V1\BatchArchiveSlatesResponse;
use Google\Ads\AdManager\V1\Client\SlateServiceClient;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent       The parent resource containing the slates.
 *                                      Format: "networks/{network_code}"
 *                                      Please see {@see SlateServiceClient::networkName()} for help formatting this field.
 * @param string $formattedNamesElement The resource names of the slates to archive.
 *                                      Format: "networks/{network_code}/slates/{slate_id}"
 *                                      Please see {@see SlateServiceClient::slateName()} for help formatting this field.
 */
function batch_archive_slates_sample(string $formattedParent, string $formattedNamesElement): void
{
    // Create a client.
    $slateServiceClient = new SlateServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var BatchArchiveSlatesResponse $response */
        $response = $slateServiceClient->batchArchiveSlates($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 = SlateServiceClient::networkName('[NETWORK_CODE]');
    $formattedNamesElement = SlateServiceClient::slateName('[NETWORK_CODE]', '[SLATE]');

    batch_archive_slates_sample($formattedParent, $formattedNamesElement);
}

batchCreateSlates

Batch creates Slate objects.

The async variant is SlateServiceClient::batchCreateSlatesAsync() .

Parameters
Name	Description
`request`	`Google\Ads\AdManager\V1\BatchCreateSlatesRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`Google\ApiCore\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\BatchCreateSlatesResponse`

Example

use Google\Ads\AdManager\V1\BatchCreateSlatesRequest;
use Google\Ads\AdManager\V1\BatchCreateSlatesResponse;
use Google\Ads\AdManager\V1\Client\SlateServiceClient;
use Google\Ads\AdManager\V1\CreateSlateRequest;
use Google\Ads\AdManager\V1\Slate;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent          The parent resource where `Slates` will be created.
 *                                         Format: `networks/{network_code}`
 *                                         The parent field in the CreateSlateRequest must match this
 *                                         field. Please see
 *                                         {@see SlateServiceClient::networkName()} for help formatting this field.
 * @param string $formattedRequestsParent  The parent resource where this `Slate` will be created.
 *                                         Format: `networks/{network_code}`
 *                                         Please see {@see SlateServiceClient::networkName()} for help formatting this field.
 * @param string $requestsSlateDisplayName The display name of the Slate. It has a maximum length of 255
 *                                         characters.
 */
function batch_create_slates_sample(
    string $formattedParent,
    string $formattedRequestsParent,
    string $requestsSlateDisplayName
): void {
    // Create a client.
    $slateServiceClient = new SlateServiceClient();

    // Prepare the request message.
    $requestsSlate = (new Slate())
        ->setDisplayName($requestsSlateDisplayName);
    $createSlateRequest = (new CreateSlateRequest())
        ->setParent($formattedRequestsParent)
        ->setSlate($requestsSlate);
    $requests = [$createSlateRequest,];
    $request = (new BatchCreateSlatesRequest())
        ->setParent($formattedParent)
        ->setRequests($requests);

    // Call the API and handle any network failures.
    try {
        /** @var BatchCreateSlatesResponse $response */
        $response = $slateServiceClient->batchCreateSlates($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 = SlateServiceClient::networkName('[NETWORK_CODE]');
    $formattedRequestsParent = SlateServiceClient::networkName('[NETWORK_CODE]');
    $requestsSlateDisplayName = '[DISPLAY_NAME]';

    batch_create_slates_sample($formattedParent, $formattedRequestsParent, $requestsSlateDisplayName);
}

batchUnarchiveSlates

Batch unarchives Slate objects.

The async variant is SlateServiceClient::batchUnarchiveSlatesAsync() .

Parameters
Name	Description
`request`	`Google\Ads\AdManager\V1\BatchUnarchiveSlatesRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`Google\ApiCore\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\BatchUnarchiveSlatesResponse`

Example

use Google\Ads\AdManager\V1\BatchUnarchiveSlatesRequest;
use Google\Ads\AdManager\V1\BatchUnarchiveSlatesResponse;
use Google\Ads\AdManager\V1\Client\SlateServiceClient;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent       The parent resource containing the slates.
 *                                      Format: "networks/{network_code}"
 *                                      Please see {@see SlateServiceClient::networkName()} for help formatting this field.
 * @param string $formattedNamesElement The resource names of the slates to unarchive.
 *                                      Format: "networks/{network_code}/slates/{slate_id}"
 *                                      Please see {@see SlateServiceClient::slateName()} for help formatting this field.
 */
function batch_unarchive_slates_sample(
    string $formattedParent,
    string $formattedNamesElement
): void {
    // Create a client.
    $slateServiceClient = new SlateServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var BatchUnarchiveSlatesResponse $response */
        $response = $slateServiceClient->batchUnarchiveSlates($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 = SlateServiceClient::networkName('[NETWORK_CODE]');
    $formattedNamesElement = SlateServiceClient::slateName('[NETWORK_CODE]', '[SLATE]');

    batch_unarchive_slates_sample($formattedParent, $formattedNamesElement);
}

batchUpdateSlates

Batch updates Slate objects.

The async variant is SlateServiceClient::batchUpdateSlatesAsync() .

Parameters
Name	Description
`request`	`Google\Ads\AdManager\V1\BatchUpdateSlatesRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`Google\ApiCore\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\BatchUpdateSlatesResponse`

Example

use Google\Ads\AdManager\V1\BatchUpdateSlatesRequest;
use Google\Ads\AdManager\V1\BatchUpdateSlatesResponse;
use Google\Ads\AdManager\V1\Client\SlateServiceClient;
use Google\Ads\AdManager\V1\Slate;
use Google\Ads\AdManager\V1\UpdateSlateRequest;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent          The parent resource where `Slates` will be updated.
 *                                         Format: `networks/{network_code}`
 *                                         The parent field in the UpdateSlateRequest must match this
 *                                         field. Please see
 *                                         {@see SlateServiceClient::networkName()} for help formatting this field.
 * @param string $requestsSlateDisplayName The display name of the Slate. It has a maximum length of 255
 *                                         characters.
 */
function batch_update_slates_sample(
    string $formattedParent,
    string $requestsSlateDisplayName
): void {
    // Create a client.
    $slateServiceClient = new SlateServiceClient();

    // Prepare the request message.
    $requestsSlate = (new Slate())
        ->setDisplayName($requestsSlateDisplayName);
    $updateSlateRequest = (new UpdateSlateRequest())
        ->setSlate($requestsSlate);
    $requests = [$updateSlateRequest,];
    $request = (new BatchUpdateSlatesRequest())
        ->setParent($formattedParent)
        ->setRequests($requests);

    // Call the API and handle any network failures.
    try {
        /** @var BatchUpdateSlatesResponse $response */
        $response = $slateServiceClient->batchUpdateSlates($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 = SlateServiceClient::networkName('[NETWORK_CODE]');
    $requestsSlateDisplayName = '[DISPLAY_NAME]';

    batch_update_slates_sample($formattedParent, $requestsSlateDisplayName);
}

createSlate

Creates a Slate object.

The async variant is SlateServiceClient::createSlateAsync() .

Parameters
Name	Description
`request`	`Google\Ads\AdManager\V1\CreateSlateRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`Google\ApiCore\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\Slate`

Example

use Google\Ads\AdManager\V1\Client\SlateServiceClient;
use Google\Ads\AdManager\V1\CreateSlateRequest;
use Google\Ads\AdManager\V1\Slate;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent  The parent resource where this `Slate` will be created.
 *                                 Format: `networks/{network_code}`
 *                                 Please see {@see SlateServiceClient::networkName()} for help formatting this field.
 * @param string $slateDisplayName The display name of the Slate. It has a maximum length of 255
 *                                 characters.
 */
function create_slate_sample(string $formattedParent, string $slateDisplayName): void
{
    // Create a client.
    $slateServiceClient = new SlateServiceClient();

    // Prepare the request message.
    $slate = (new Slate())
        ->setDisplayName($slateDisplayName);
    $request = (new CreateSlateRequest())
        ->setParent($formattedParent)
        ->setSlate($slate);

    // Call the API and handle any network failures.
    try {
        /** @var Slate $response */
        $response = $slateServiceClient->createSlate($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 = SlateServiceClient::networkName('[NETWORK_CODE]');
    $slateDisplayName = '[DISPLAY_NAME]';

    create_slate_sample($formattedParent, $slateDisplayName);
}

getSlate

Retrieves a Slate object.

The async variant is SlateServiceClient::getSlateAsync() .

Parameters
Name	Description
`request`	`Google\Ads\AdManager\V1\GetSlateRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`Google\ApiCore\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\Slate`

Example

use Google\Ads\AdManager\V1\Client\SlateServiceClient;
use Google\Ads\AdManager\V1\GetSlateRequest;
use Google\Ads\AdManager\V1\Slate;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedName The resource name of the Slate to retrieve.
 *                              Format: `networks/{network_code}/slates/{slate_id}`
 *                              Please see {@see SlateServiceClient::slateName()} for help formatting this field.
 */
function get_slate_sample(string $formattedName): void
{
    // Create a client.
    $slateServiceClient = new SlateServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Slate $response */
        $response = $slateServiceClient->getSlate($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 = SlateServiceClient::slateName('[NETWORK_CODE]', '[SLATE]');

    get_slate_sample($formattedName);
}

listSlates

Lists Slate objects.

The async variant is SlateServiceClient::listSlatesAsync() .

Parameters
Name	Description
`request`	`Google\Ads\AdManager\V1\ListSlatesRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`Google\ApiCore\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\SlateServiceClient;
use Google\Ads\AdManager\V1\ListSlatesRequest;
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;

/**
 * @param string $formattedParent The parent resource containing the Slates.
 *                                Format: `networks/{network_code}`
 *                                Please see {@see SlateServiceClient::networkName()} for help formatting this field.
 */
function list_slates_sample(string $formattedParent): void
{
    // Create a client.
    $slateServiceClient = new SlateServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $slateServiceClient->listSlates($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 = SlateServiceClient::networkName('[NETWORK_CODE]');

    list_slates_sample($formattedParent);
}

updateSlate

Updates a Slate object.

The async variant is SlateServiceClient::updateSlateAsync() .

Parameters
Name	Description
`request`	`Google\Ads\AdManager\V1\UpdateSlateRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`Google\ApiCore\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\Slate`

Example

use Google\Ads\AdManager\V1\Client\SlateServiceClient;
use Google\Ads\AdManager\V1\Slate;
use Google\Ads\AdManager\V1\UpdateSlateRequest;
use Google\ApiCore\ApiException;

/**
 * @param string $slateDisplayName The display name of the Slate. It has a maximum length of 255
 *                                 characters.
 */
function update_slate_sample(string $slateDisplayName): void
{
    // Create a client.
    $slateServiceClient = new SlateServiceClient();

    // Prepare the request message.
    $slate = (new Slate())
        ->setDisplayName($slateDisplayName);
    $request = (new UpdateSlateRequest())
        ->setSlate($slate);

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

    update_slate_sample($slateDisplayName);
}

batchArchiveSlatesAsync

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

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

batchCreateSlatesAsync

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

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

batchUnarchiveSlatesAsync

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

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

batchUpdateSlatesAsync

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

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

createSlateAsync

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

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

getSlateAsync

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

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

listSlatesAsync

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

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

updateSlateAsync

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

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

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::slateName

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

Parameters
Name	Description
`networkCode`	`string`
`slate`	`string`

Returns
Type	Description
`string`	The formatted slate 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}
slate: networks/{network_code}/slates/{slate}

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 SlateServiceClient (0.14.1) Stay organized with collections Save and categorize content based on your preferences.

Namespace

Methods

__construct

batchArchiveSlates

batchCreateSlates

batchUnarchiveSlates

batchUpdateSlates

createSlate

getSlate

listSlates

updateSlate

batchArchiveSlatesAsync

batchCreateSlatesAsync

batchUnarchiveSlatesAsync

batchUpdateSlatesAsync

createSlateAsync

getSlateAsync

listSlatesAsync

updateSlateAsync

static::networkName

static::slateName

static::parseName

Google Ads Ad Manager V1 Client - Class SlateServiceClient (0.14.1)