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

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

Service Description: Provides methods for handling CreativeSet 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\CreativeSetServiceClient; $creds = new ServiceAccountCredentials($scopes, $json); $options = new CreativeSetServiceClient(['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'.

createCreativeSet

Creates a CreativeSet object.

The async variant is CreativeSetServiceClient::createCreativeSetAsync() .

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

Example

use Google\Ads\AdManager\V1\Client\CreativeSetServiceClient;
use Google\Ads\AdManager\V1\CreateCreativeSetRequest;
use Google\Ads\AdManager\V1\CreativeSet;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent                               The parent resource where this `CreativeSet` will be created.
 *                                                              Format: `networks/{network_code}`
 *                                                              Please see {@see CreativeSetServiceClient::networkName()} for help formatting this field.
 * @param string $creativeSetDisplayName                        The name of the `CreativeSet`. This attribute has a maximum
 *                                                              length of 255 characters.
 * @param string $formattedCreativeSetMasterCreative            Immutable. The master
 *                                                              [Creative](google.ads.admanager.v1.Creative) to which the `CreativeSet` is
 *                                                              associated. Please see
 *                                                              {@see CreativeSetServiceClient::creativeName()} for help formatting this field.
 * @param string $formattedCreativeSetCompanionCreativesElement The resource names of the companion `Creative`s associated with
 *                                                              this `CreativeSet`. Format: `networks/{network_code}/creatives/{creative}`
 *                                                              Please see {@see CreativeSetServiceClient::creativeName()} for help formatting this field.
 */
function create_creative_set_sample(
    string $formattedParent,
    string $creativeSetDisplayName,
    string $formattedCreativeSetMasterCreative,
    string $formattedCreativeSetCompanionCreativesElement
): void {
    // Create a client.
    $creativeSetServiceClient = new CreativeSetServiceClient();

    // Prepare the request message.
    $formattedCreativeSetCompanionCreatives = [$formattedCreativeSetCompanionCreativesElement,];
    $creativeSet = (new CreativeSet())
        ->setDisplayName($creativeSetDisplayName)
        ->setMasterCreative($formattedCreativeSetMasterCreative)
        ->setCompanionCreatives($formattedCreativeSetCompanionCreatives);
    $request = (new CreateCreativeSetRequest())
        ->setParent($formattedParent)
        ->setCreativeSet($creativeSet);

    // Call the API and handle any network failures.
    try {
        /** @var CreativeSet $response */
        $response = $creativeSetServiceClient->createCreativeSet($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 = CreativeSetServiceClient::networkName('[NETWORK_CODE]');
    $creativeSetDisplayName = '[DISPLAY_NAME]';
    $formattedCreativeSetMasterCreative = CreativeSetServiceClient::creativeName(
        '[NETWORK_CODE]',
        '[CREATIVE]'
    );
    $formattedCreativeSetCompanionCreativesElement = CreativeSetServiceClient::creativeName(
        '[NETWORK_CODE]',
        '[CREATIVE]'
    );

    create_creative_set_sample(
        $formattedParent,
        $creativeSetDisplayName,
        $formattedCreativeSetMasterCreative,
        $formattedCreativeSetCompanionCreativesElement
    );
}

getCreativeSet

Retrieves a CreativeSet object.

The async variant is CreativeSetServiceClient::getCreativeSetAsync() .

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

Example

use Google\Ads\AdManager\V1\Client\CreativeSetServiceClient;
use Google\Ads\AdManager\V1\CreativeSet;
use Google\Ads\AdManager\V1\GetCreativeSetRequest;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedName The resource name of the CreativeSet.
 *                              Format: `networks/{network_code}/creativeSets/{creative_set_id}`
 *                              Please see {@see CreativeSetServiceClient::creativeSetName()} for help formatting this field.
 */
function get_creative_set_sample(string $formattedName): void
{
    // Create a client.
    $creativeSetServiceClient = new CreativeSetServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var CreativeSet $response */
        $response = $creativeSetServiceClient->getCreativeSet($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 = CreativeSetServiceClient::creativeSetName('[NETWORK_CODE]', '[CREATIVE_SET]');

    get_creative_set_sample($formattedName);
}

listCreativeSets

Lists CreativeSet objects.

The async variant is CreativeSetServiceClient::listCreativeSetsAsync() .

Parameters
Name	Description
`request`	`Google\Ads\AdManager\V1\ListCreativeSetsRequest` 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\CreativeSetServiceClient;
use Google\Ads\AdManager\V1\ListCreativeSetsRequest;
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;

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

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

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

    list_creative_sets_sample($formattedParent);
}

updateCreativeSet

Updates a CreativeSet object.

The async variant is CreativeSetServiceClient::updateCreativeSetAsync() .

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

Example

use Google\Ads\AdManager\V1\Client\CreativeSetServiceClient;
use Google\Ads\AdManager\V1\CreativeSet;
use Google\Ads\AdManager\V1\UpdateCreativeSetRequest;
use Google\ApiCore\ApiException;

/**
 * @param string $creativeSetDisplayName                        The name of the `CreativeSet`. This attribute has a maximum
 *                                                              length of 255 characters.
 * @param string $formattedCreativeSetMasterCreative            Immutable. The master
 *                                                              [Creative](google.ads.admanager.v1.Creative) to which the `CreativeSet` is
 *                                                              associated. Please see
 *                                                              {@see CreativeSetServiceClient::creativeName()} for help formatting this field.
 * @param string $formattedCreativeSetCompanionCreativesElement The resource names of the companion `Creative`s associated with
 *                                                              this `CreativeSet`. Format: `networks/{network_code}/creatives/{creative}`
 *                                                              Please see {@see CreativeSetServiceClient::creativeName()} for help formatting this field.
 */
function update_creative_set_sample(
    string $creativeSetDisplayName,
    string $formattedCreativeSetMasterCreative,
    string $formattedCreativeSetCompanionCreativesElement
): void {
    // Create a client.
    $creativeSetServiceClient = new CreativeSetServiceClient();

    // Prepare the request message.
    $formattedCreativeSetCompanionCreatives = [$formattedCreativeSetCompanionCreativesElement,];
    $creativeSet = (new CreativeSet())
        ->setDisplayName($creativeSetDisplayName)
        ->setMasterCreative($formattedCreativeSetMasterCreative)
        ->setCompanionCreatives($formattedCreativeSetCompanionCreatives);
    $request = (new UpdateCreativeSetRequest())
        ->setCreativeSet($creativeSet);

    // Call the API and handle any network failures.
    try {
        /** @var CreativeSet $response */
        $response = $creativeSetServiceClient->updateCreativeSet($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
{
    $creativeSetDisplayName = '[DISPLAY_NAME]';
    $formattedCreativeSetMasterCreative = CreativeSetServiceClient::creativeName(
        '[NETWORK_CODE]',
        '[CREATIVE]'
    );
    $formattedCreativeSetCompanionCreativesElement = CreativeSetServiceClient::creativeName(
        '[NETWORK_CODE]',
        '[CREATIVE]'
    );

    update_creative_set_sample(
        $creativeSetDisplayName,
        $formattedCreativeSetMasterCreative,
        $formattedCreativeSetCompanionCreativesElement
    );
}

createCreativeSetAsync

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

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

getCreativeSetAsync

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

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

listCreativeSetsAsync

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

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

updateCreativeSetAsync

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

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

static::creativeName

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

Parameters
Name	Description
`networkCode`	`string`
`creative`	`string`

Returns
Type	Description
`string`	The formatted creative resource.

static::creativeSetName

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

Parameters
Name	Description
`networkCode`	`string`
`creativeSet`	`string`

Returns
Type	Description
`string`	The formatted creative_set resource.

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

creative: networks/{network_code}/creatives/{creative}
creativeSet: networks/{network_code}/creativeSets/{creative_set}
network: networks/{network_code}

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

Namespace

Methods

__construct

createCreativeSet

getCreativeSet

listCreativeSets

updateCreativeSet

createCreativeSetAsync

getCreativeSetAsync

listCreativeSetsAsync

updateCreativeSetAsync

static::creativeName

static::creativeSetName

static::networkName

static::parseName

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