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

use Google\Ads\AdManager\V1\BatchCreateCompaniesRequest;
use Google\Ads\AdManager\V1\BatchCreateCompaniesResponse;
use Google\Ads\AdManager\V1\Client\CompanyServiceClient;
use Google\Ads\AdManager\V1\Company;
use Google\Ads\AdManager\V1\CompanyTypeEnum\CompanyType;
use Google\Ads\AdManager\V1\CreateCompanyRequest;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent            The parent resource where [Companies][] will be created.
 *                                           Format: `networks/{network_code}`
 *                                           The parent field in the CreateCompanyRequest must match this
 *                                           field. Please see
 *                                           {@see CompanyServiceClient::networkName()} for help formatting this field.
 * @param string $formattedRequestsParent    The parent resource where this
 *                                           [Company][google.ads.admanager.v1.Company] will be created. Format:
 *                                           `networks/{network_code}`
 *                                           Please see {@see CompanyServiceClient::networkName()} for help formatting this field.
 * @param string $requestsCompanyDisplayName The display name of the
 *                                           [Company][google.ads.admanager.v1.Company].
 *
 *                                           This value has a maximum length of 127 characters.
 * @param int    $requestsCompanyType        The type of the [Company][google.ads.admanager.v1.Company].
 */
function batch_create_companies_sample(
    string $formattedParent,
    string $formattedRequestsParent,
    string $requestsCompanyDisplayName,
    int $requestsCompanyType
): void {
    // Create a client.
    $companyServiceClient = new CompanyServiceClient();

    // Prepare the request message.
    $requestsCompany = (new Company())
        ->setDisplayName($requestsCompanyDisplayName)
        ->setType($requestsCompanyType);
    $createCompanyRequest = (new CreateCompanyRequest())
        ->setParent($formattedRequestsParent)
        ->setCompany($requestsCompany);
    $requests = [$createCompanyRequest,];
    $request = (new BatchCreateCompaniesRequest())
        ->setParent($formattedParent)
        ->setRequests($requests);

    // Call the API and handle any network failures.
    try {
        /** @var BatchCreateCompaniesResponse $response */
        $response = $companyServiceClient->batchCreateCompanies($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 = CompanyServiceClient::networkName('[NETWORK_CODE]');
    $formattedRequestsParent = CompanyServiceClient::networkName('[NETWORK_CODE]');
    $requestsCompanyDisplayName = '[DISPLAY_NAME]';
    $requestsCompanyType = CompanyType::COMPANY_TYPE_UNSPECIFIED;

    batch_create_companies_sample(
        $formattedParent,
        $formattedRequestsParent,
        $requestsCompanyDisplayName,
        $requestsCompanyType
    );
}

use Google\Ads\AdManager\V1\BatchUpdateCompaniesRequest;
use Google\Ads\AdManager\V1\BatchUpdateCompaniesResponse;
use Google\Ads\AdManager\V1\Client\CompanyServiceClient;
use Google\Ads\AdManager\V1\Company;
use Google\Ads\AdManager\V1\CompanyTypeEnum\CompanyType;
use Google\Ads\AdManager\V1\UpdateCompanyRequest;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent            The parent resource where [Companies][] will be updated.
 *                                           Format: `networks/{network_code}`
 *                                           The parent field in the UpdateCompanyRequest must match this
 *                                           field. Please see
 *                                           {@see CompanyServiceClient::networkName()} for help formatting this field.
 * @param string $requestsCompanyDisplayName The display name of the
 *                                           [Company][google.ads.admanager.v1.Company].
 *
 *                                           This value has a maximum length of 127 characters.
 * @param int    $requestsCompanyType        The type of the [Company][google.ads.admanager.v1.Company].
 */
function batch_update_companies_sample(
    string $formattedParent,
    string $requestsCompanyDisplayName,
    int $requestsCompanyType
): void {
    // Create a client.
    $companyServiceClient = new CompanyServiceClient();

    // Prepare the request message.
    $requestsCompany = (new Company())
        ->setDisplayName($requestsCompanyDisplayName)
        ->setType($requestsCompanyType);
    $updateCompanyRequest = (new UpdateCompanyRequest())
        ->setCompany($requestsCompany);
    $requests = [$updateCompanyRequest,];
    $request = (new BatchUpdateCompaniesRequest())
        ->setParent($formattedParent)
        ->setRequests($requests);

    // Call the API and handle any network failures.
    try {
        /** @var BatchUpdateCompaniesResponse $response */
        $response = $companyServiceClient->batchUpdateCompanies($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 = CompanyServiceClient::networkName('[NETWORK_CODE]');
    $requestsCompanyDisplayName = '[DISPLAY_NAME]';
    $requestsCompanyType = CompanyType::COMPANY_TYPE_UNSPECIFIED;

    batch_update_companies_sample($formattedParent, $requestsCompanyDisplayName, $requestsCompanyType);
}

use Google\Ads\AdManager\V1\Client\CompanyServiceClient;
use Google\Ads\AdManager\V1\Company;
use Google\Ads\AdManager\V1\CompanyTypeEnum\CompanyType;
use Google\Ads\AdManager\V1\CreateCompanyRequest;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent    The parent resource where this
 *                                   [Company][google.ads.admanager.v1.Company] will be created. Format:
 *                                   `networks/{network_code}`
 *                                   Please see {@see CompanyServiceClient::networkName()} for help formatting this field.
 * @param string $companyDisplayName The display name of the
 *                                   [Company][google.ads.admanager.v1.Company].
 *
 *                                   This value has a maximum length of 127 characters.
 * @param int    $companyType        The type of the [Company][google.ads.admanager.v1.Company].
 */
function create_company_sample(
    string $formattedParent,
    string $companyDisplayName,
    int $companyType
): void {
    // Create a client.
    $companyServiceClient = new CompanyServiceClient();

    // Prepare the request message.
    $company = (new Company())
        ->setDisplayName($companyDisplayName)
        ->setType($companyType);
    $request = (new CreateCompanyRequest())
        ->setParent($formattedParent)
        ->setCompany($company);

    // Call the API and handle any network failures.
    try {
        /** @var Company $response */
        $response = $companyServiceClient->createCompany($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 = CompanyServiceClient::networkName('[NETWORK_CODE]');
    $companyDisplayName = '[DISPLAY_NAME]';
    $companyType = CompanyType::COMPANY_TYPE_UNSPECIFIED;

    create_company_sample($formattedParent, $companyDisplayName, $companyType);
}

use Google\Ads\AdManager\V1\Client\CompanyServiceClient;
use Google\Ads\AdManager\V1\Company;
use Google\Ads\AdManager\V1\GetCompanyRequest;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedName The resource name of the Company.
 *                              Format: `networks/{network_code}/companies/{company_id}`
 *                              Please see {@see CompanyServiceClient::companyName()} for help formatting this field.
 */
function get_company_sample(string $formattedName): void
{
    // Create a client.
    $companyServiceClient = new CompanyServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Company $response */
        $response = $companyServiceClient->getCompany($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 = CompanyServiceClient::companyName('[NETWORK_CODE]', '[COMPANY]');

    get_company_sample($formattedName);
}

use Google\Ads\AdManager\V1\Client\CompanyServiceClient;
use Google\Ads\AdManager\V1\ListCompaniesRequest;
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;

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

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

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

    list_companies_sample($formattedParent);
}

use Google\Ads\AdManager\V1\Client\CompanyServiceClient;
use Google\Ads\AdManager\V1\Company;
use Google\Ads\AdManager\V1\CompanyTypeEnum\CompanyType;
use Google\Ads\AdManager\V1\UpdateCompanyRequest;
use Google\ApiCore\ApiException;

/**
 * @param string $companyDisplayName The display name of the
 *                                   [Company][google.ads.admanager.v1.Company].
 *
 *                                   This value has a maximum length of 127 characters.
 * @param int    $companyType        The type of the [Company][google.ads.admanager.v1.Company].
 */
function update_company_sample(string $companyDisplayName, int $companyType): void
{
    // Create a client.
    $companyServiceClient = new CompanyServiceClient();

    // Prepare the request message.
    $company = (new Company())
        ->setDisplayName($companyDisplayName)
        ->setType($companyType);
    $request = (new UpdateCompanyRequest())
        ->setCompany($company);

    // Call the API and handle any network failures.
    try {
        /** @var Company $response */
        $response = $companyServiceClient->updateCompany($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
{
    $companyDisplayName = '[DISPLAY_NAME]';
    $companyType = CompanyType::COMPANY_TYPE_UNSPECIFIED;

    update_company_sample($companyDisplayName, $companyType);
}