Google Ads Marketing Platform Admin V1alpha Client - Class MarketingplatformAdminServiceClient (0.1.0)

use Google\Ads\MarketingPlatform\Admin\V1alpha\AnalyticsAccountLink;
use Google\Ads\MarketingPlatform\Admin\V1alpha\Client\MarketingplatformAdminServiceClient;
use Google\Ads\MarketingPlatform\Admin\V1alpha\CreateAnalyticsAccountLinkRequest;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent                               The parent resource where this Analytics account link will be
 *                                                              created. Format: organizations/{org_id}
 *                                                              Please see {@see MarketingplatformAdminServiceClient::organizationName()} for help formatting this field.
 * @param string $formattedAnalyticsAccountLinkAnalyticsAccount Immutable. The resource name of the AnalyticsAdmin API account.
 *                                                              The account ID will be used as the ID of this AnalyticsAccountLink
 *                                                              resource, which will become the final component of the resource name.
 *
 *                                                              Format: analyticsadmin.googleapis.com/accounts/{account_id}
 *                                                              Please see {@see MarketingplatformAdminServiceClient::accountName()} for help formatting this field.
 */
function create_analytics_account_link_sample(
    string $formattedParent,
    string $formattedAnalyticsAccountLinkAnalyticsAccount
): void {
    // Create a client.
    $marketingplatformAdminServiceClient = new MarketingplatformAdminServiceClient();

    // Prepare the request message.
    $analyticsAccountLink = (new AnalyticsAccountLink())
        ->setAnalyticsAccount($formattedAnalyticsAccountLinkAnalyticsAccount);
    $request = (new CreateAnalyticsAccountLinkRequest())
        ->setParent($formattedParent)
        ->setAnalyticsAccountLink($analyticsAccountLink);

    // Call the API and handle any network failures.
    try {
        /** @var AnalyticsAccountLink $response */
        $response = $marketingplatformAdminServiceClient->createAnalyticsAccountLink($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 = MarketingplatformAdminServiceClient::organizationName('[ORGANIZATION]');
    $formattedAnalyticsAccountLinkAnalyticsAccount = MarketingplatformAdminServiceClient::accountName(
        '[ACCOUNT]'
    );

    create_analytics_account_link_sample(
        $formattedParent,
        $formattedAnalyticsAccountLinkAnalyticsAccount
    );
}

use Google\Ads\MarketingPlatform\Admin\V1alpha\Client\MarketingplatformAdminServiceClient;
use Google\Ads\MarketingPlatform\Admin\V1alpha\DeleteAnalyticsAccountLinkRequest;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedName The name of the Analytics account link to delete.
 *                              Format:
 *                              organizations/{org_id}/analyticsAccountLinks/{analytics_account_link_id}
 *                              Please see {@see MarketingplatformAdminServiceClient::analyticsAccountLinkName()} for help formatting this field.
 */
function delete_analytics_account_link_sample(string $formattedName): void
{
    // Create a client.
    $marketingplatformAdminServiceClient = new MarketingplatformAdminServiceClient();

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

    // Call the API and handle any network failures.
    try {
        $marketingplatformAdminServiceClient->deleteAnalyticsAccountLink($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 = MarketingplatformAdminServiceClient::analyticsAccountLinkName(
        '[ORGANIZATION]',
        '[ANALYTICS_ACCOUNT_LINK]'
    );

    delete_analytics_account_link_sample($formattedName);
}

use Google\Ads\MarketingPlatform\Admin\V1alpha\Client\MarketingplatformAdminServiceClient;
use Google\Ads\MarketingPlatform\Admin\V1alpha\GetOrganizationRequest;
use Google\Ads\MarketingPlatform\Admin\V1alpha\Organization;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedName The name of the Organization to retrieve.
 *                              Format: organizations/{org_id}
 *                              Please see {@see MarketingplatformAdminServiceClient::organizationName()} for help formatting this field.
 */
function get_organization_sample(string $formattedName): void
{
    // Create a client.
    $marketingplatformAdminServiceClient = new MarketingplatformAdminServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Organization $response */
        $response = $marketingplatformAdminServiceClient->getOrganization($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 = MarketingplatformAdminServiceClient::organizationName('[ORGANIZATION]');

    get_organization_sample($formattedName);
}

use Google\Ads\MarketingPlatform\Admin\V1alpha\AnalyticsAccountLink;
use Google\Ads\MarketingPlatform\Admin\V1alpha\Client\MarketingplatformAdminServiceClient;
use Google\Ads\MarketingPlatform\Admin\V1alpha\ListAnalyticsAccountLinksRequest;
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;

/**
 * @param string $formattedParent The parent organization, which owns this collection of Analytics
 *                                account links. Format: organizations/{org_id}
 *                                Please see {@see MarketingplatformAdminServiceClient::organizationName()} for help formatting this field.
 */
function list_analytics_account_links_sample(string $formattedParent): void
{
    // Create a client.
    $marketingplatformAdminServiceClient = new MarketingplatformAdminServiceClient();

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

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

        /** @var AnalyticsAccountLink $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 = MarketingplatformAdminServiceClient::organizationName('[ORGANIZATION]');

    list_analytics_account_links_sample($formattedParent);
}

use Google\Ads\MarketingPlatform\Admin\V1alpha\AnalyticsServiceLevel;
use Google\Ads\MarketingPlatform\Admin\V1alpha\Client\MarketingplatformAdminServiceClient;
use Google\Ads\MarketingPlatform\Admin\V1alpha\SetPropertyServiceLevelRequest;
use Google\Ads\MarketingPlatform\Admin\V1alpha\SetPropertyServiceLevelResponse;
use Google\ApiCore\ApiException;

/**
 * @param string $analyticsAccountLink       The parent AnalyticsAccountLink scope where this property is in.
 *                                           Format:
 *                                           organizations/{org_id}/analyticsAccountLinks/{analytics_account_link_id}
 * @param string $formattedAnalyticsProperty The Analytics property to change the ServiceLevel setting. This
 *                                           field is the name of the Google Analytics Admin API property resource.
 *
 *                                           Format: analyticsadmin.googleapis.com/properties/{property_id}
 *                                           Please see {@see MarketingplatformAdminServiceClient::propertyName()} for help formatting this field.
 * @param int    $serviceLevel               The service level to set for this property.
 */
function set_property_service_level_sample(
    string $analyticsAccountLink,
    string $formattedAnalyticsProperty,
    int $serviceLevel
): void {
    // Create a client.
    $marketingplatformAdminServiceClient = new MarketingplatformAdminServiceClient();

    // Prepare the request message.
    $request = (new SetPropertyServiceLevelRequest())
        ->setAnalyticsAccountLink($analyticsAccountLink)
        ->setAnalyticsProperty($formattedAnalyticsProperty)
        ->setServiceLevel($serviceLevel);

    // Call the API and handle any network failures.
    try {
        /** @var SetPropertyServiceLevelResponse $response */
        $response = $marketingplatformAdminServiceClient->setPropertyServiceLevel($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
{
    $analyticsAccountLink = '[ANALYTICS_ACCOUNT_LINK]';
    $formattedAnalyticsProperty = MarketingplatformAdminServiceClient::propertyName('[PROPERTY]');
    $serviceLevel = AnalyticsServiceLevel::ANALYTICS_SERVICE_LEVEL_UNSPECIFIED;

    set_property_service_level_sample(
        $analyticsAccountLink,
        $formattedAnalyticsProperty,
        $serviceLevel
    );
}