Google Ads Data Manager V1 Client - Class MarketingDataInsightsServiceClient (0.2.0)

Reference documentation and code samples for the Google Ads Data Manager V1 Client class MarketingDataInsightsServiceClient.

Service Description: Service to return insights on marketing data.

This feature is only available to data partners.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods.

Namespace

Google \ Ads \ DataManager \ 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\DataManager\V1\MarketingDataInsightsServiceClient; $creds = new ServiceAccountCredentials($scopes, $json); $options = new MarketingDataInsightsServiceClient(['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. May be either the string rest or grpc. Defaults to grpc if gRPC support is detected on the system. 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 = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods 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'.

retrieveInsights

Retrieves marketing data insights for a given user list.

This feature is only available to data partners.

Authorization Headers:

This method supports the following optional headers to define how the API authorizes access for the request:

  • login-account: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: accountTypes/{loginAccountType}/accounts/{loginAccountId}
  • linked-account: (Optional) The resource name of the account with an established product link to the login-account. Format: accountTypes/{linkedAccountType}/accounts/{linkedAccountId}

The async variant is MarketingDataInsightsServiceClient::retrieveInsightsAsync() .

Parameters
Name Description
request Google\Ads\DataManager\V1\RetrieveInsightsRequest

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\DataManager\V1\RetrieveInsightsResponse
Example 
use Google\Ads\DataManager\V1\Baseline;
use Google\Ads\DataManager\V1\Client\MarketingDataInsightsServiceClient;
use Google\Ads\DataManager\V1\RetrieveInsightsRequest;
use Google\Ads\DataManager\V1\RetrieveInsightsResponse;
use Google\ApiCore\ApiException;

/**
 * @param string $parent     The parent account that owns the user list.
 *                           Format: `accountTypes/{account_type}/accounts/{account}`
 * @param string $userListId The user list ID for which insights are requested.
 */
function retrieve_insights_sample(string $parent, string $userListId): void
{
    // Create a client.
    $marketingDataInsightsServiceClient = new MarketingDataInsightsServiceClient();

    // Prepare the request message.
    $baseline = new Baseline();
    $request = (new RetrieveInsightsRequest())
        ->setParent($parent)
        ->setBaseline($baseline)
        ->setUserListId($userListId);

    // Call the API and handle any network failures.
    try {
        /** @var RetrieveInsightsResponse $response */
        $response = $marketingDataInsightsServiceClient->retrieveInsights($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
{
    $parent = '[PARENT]';
    $userListId = '[USER_LIST_ID]';

    retrieve_insights_sample($parent, $userListId);
}

retrieveInsightsAsync

Parameters
Name Description
request Google\Ads\DataManager\V1\RetrieveInsightsRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Ads\DataManager\V1\RetrieveInsightsResponse>