Class MarketingDataInsightsServiceClient

MarketingDataInsightsService client wrapper, for convenient use.

Inheritance

object

MarketingDataInsightsServiceClient

MarketingDataInsightsServiceClientImpl

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace: Google.Ads.DataManager.V1

Assembly: Google.Ads.DataManager.V1.dll

Syntax

public abstract class MarketingDataInsightsServiceClient

Remarks

Service to return insights on marketing data.

This feature is only available to data partners.

Properties

DefaultEndpoint

The default endpoint for the MarketingDataInsightsService service, which is a host of "datamanager.googleapis.com" and a port of 443.

Declaration

public static string DefaultEndpoint { get; }

Property Value

Type	Description
string

DefaultScopes

The default MarketingDataInsightsService scopes.

Declaration

public static IReadOnlyList<string> DefaultScopes { get; }

Property Value

Type	Description
IReadOnlyList<string>

Remarks

The default MarketingDataInsightsService scopes are:

https://www.googleapis.com/auth/datamanager

GrpcClient

The underlying gRPC MarketingDataInsightsService client

Declaration

public virtual MarketingDataInsightsService.MarketingDataInsightsServiceClient GrpcClient { get; }

Property Value

Type	Description
MarketingDataInsightsService.MarketingDataInsightsServiceClient

ServiceMetadata

The service metadata associated with this client type.

Declaration

public static ServiceMetadata ServiceMetadata { get; }

Property Value

Type	Description
ServiceMetadata

Methods

Create()

Synchronously creates a MarketingDataInsightsServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use MarketingDataInsightsServiceClientBuilder.

Declaration

public static MarketingDataInsightsServiceClient Create()

Returns

Type	Description
MarketingDataInsightsServiceClient	The created MarketingDataInsightsServiceClient.

CreateAsync(CancellationToken)

Asynchronously creates a MarketingDataInsightsServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use MarketingDataInsightsServiceClientBuilder.

Declaration

public static Task<MarketingDataInsightsServiceClient> CreateAsync(CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The CancellationToken to use while creating the client.

Returns

Type	Description
Task<MarketingDataInsightsServiceClient>	The task representing the created MarketingDataInsightsServiceClient.

RetrieveInsights(RetrieveInsightsRequest, CallSettings)

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}

Declaration

public virtual RetrieveInsightsResponse RetrieveInsights(RetrieveInsightsRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
RetrieveInsightsRequest	request	The request object containing all of the parameters for the API call.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
RetrieveInsightsResponse	The RPC response.

Sample code

// Create client
MarketingDataInsightsServiceClient marketingDataInsightsServiceClient = MarketingDataInsightsServiceClient.Create();
// Initialize request argument(s)
RetrieveInsightsRequest request = new RetrieveInsightsRequest
{
    Parent = "",
    Baseline = new Baseline(),
    UserListId = "",
};
// Make the request
RetrieveInsightsResponse response = marketingDataInsightsServiceClient.RetrieveInsights(request);

RetrieveInsightsAsync(RetrieveInsightsRequest, CallSettings)

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}

Declaration

public virtual Task<RetrieveInsightsResponse> RetrieveInsightsAsync(RetrieveInsightsRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
RetrieveInsightsRequest	request	The request object containing all of the parameters for the API call.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
Task<RetrieveInsightsResponse>	A Task containing the RPC response.

Sample code

// Create client
MarketingDataInsightsServiceClient marketingDataInsightsServiceClient = await MarketingDataInsightsServiceClient.CreateAsync();
// Initialize request argument(s)
RetrieveInsightsRequest request = new RetrieveInsightsRequest
{
    Parent = "",
    Baseline = new Baseline(),
    UserListId = "",
};
// Make the request
RetrieveInsightsResponse response = await marketingDataInsightsServiceClient.RetrieveInsightsAsync(request);

RetrieveInsightsAsync(RetrieveInsightsRequest, CancellationToken)

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}

Declaration

public virtual Task<RetrieveInsightsResponse> RetrieveInsightsAsync(RetrieveInsightsRequest request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
RetrieveInsightsRequest	request	The request object containing all of the parameters for the API call.
CancellationToken	cancellationToken	A CancellationToken to use for this RPC.

Returns

Type	Description
Task<RetrieveInsightsResponse>	A Task containing the RPC response.

Sample code

// Create client
MarketingDataInsightsServiceClient marketingDataInsightsServiceClient = await MarketingDataInsightsServiceClient.CreateAsync();
// Initialize request argument(s)
RetrieveInsightsRequest request = new RetrieveInsightsRequest
{
    Parent = "",
    Baseline = new Baseline(),
    UserListId = "",
};
// Make the request
RetrieveInsightsResponse response = await marketingDataInsightsServiceClient.RetrieveInsightsAsync(request);

ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Declaration

public static Task ShutdownDefaultChannelsAsync()

Returns

Type	Description
Task	A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.