Show / Hide Table of Contents

Class NetworkServiceClientImpl

NetworkService client wrapper implementation, for convenient use.

Inheritance
object
NetworkServiceClient
NetworkServiceClientImpl
Inherited Members
NetworkServiceClient.DefaultEndpoint
NetworkServiceClient.DefaultScopes
NetworkServiceClient.ServiceMetadata
NetworkServiceClient.CreateAsync(CancellationToken)
NetworkServiceClient.Create()
NetworkServiceClient.ShutdownDefaultChannelsAsync()
NetworkServiceClient.GetNetworkAsync(GetNetworkRequest, CancellationToken)
NetworkServiceClient.GetNetwork(string, CallSettings)
NetworkServiceClient.GetNetworkAsync(string, CallSettings)
NetworkServiceClient.GetNetworkAsync(string, CancellationToken)
NetworkServiceClient.GetNetwork(NetworkName, CallSettings)
NetworkServiceClient.GetNetworkAsync(NetworkName, CallSettings)
NetworkServiceClient.GetNetworkAsync(NetworkName, CancellationToken)
NetworkServiceClient.UpdateNetworkAsync(UpdateNetworkRequest, CancellationToken)
NetworkServiceClient.UpdateNetwork(Network, FieldMask, CallSettings)
NetworkServiceClient.UpdateNetworkAsync(Network, FieldMask, CallSettings)
NetworkServiceClient.UpdateNetworkAsync(Network, FieldMask, CancellationToken)
NetworkServiceClient.ProvisionTestNetworkAsync(ProvisionTestNetworkRequest, CancellationToken)
NetworkServiceClient.GetDefaultThirdPartyDataDeclarationAsync(GetDefaultThirdPartyDataDeclarationRequest, CancellationToken)
NetworkServiceClient.GetDefaultThirdPartyDataDeclaration(string, CallSettings)
NetworkServiceClient.GetDefaultThirdPartyDataDeclarationAsync(string, CallSettings)
NetworkServiceClient.GetDefaultThirdPartyDataDeclarationAsync(string, CancellationToken)
NetworkServiceClient.GetDefaultThirdPartyDataDeclaration(DefaultThirdPartyDataDeclarationName, CallSettings)
NetworkServiceClient.GetDefaultThirdPartyDataDeclarationAsync(DefaultThirdPartyDataDeclarationName, CallSettings)
NetworkServiceClient.GetDefaultThirdPartyDataDeclarationAsync(DefaultThirdPartyDataDeclarationName, CancellationToken)
object.GetHashCode()
object.GetType()
object.ToString()
Namespace: Google.Ads.AdManager.V1
Assembly: Google.Ads.AdManager.V1.dll
Syntax
public sealed class NetworkServiceClientImpl : NetworkServiceClient
Remarks

Provides methods for handling Network objects.

Constructors

NetworkServiceClientImpl(NetworkServiceClient, NetworkServiceSettings, ILogger)

Constructs a client wrapper for the NetworkService service, with the specified gRPC client and settings.

Declaration
public NetworkServiceClientImpl(NetworkService.NetworkServiceClient grpcClient, NetworkServiceSettings settings, ILogger logger)
Parameters
Type Name Description
NetworkService.NetworkServiceClient grpcClient

The underlying gRPC client.

NetworkServiceSettings settings

The base NetworkServiceSettings used within this client.

ILogger logger

Optional ILogger to use within this client.

Properties

GrpcClient

The underlying gRPC NetworkService client

Declaration
public override NetworkService.NetworkServiceClient GrpcClient { get; }
Property Value
Type Description
NetworkService.NetworkServiceClient
Overrides
NetworkServiceClient.GrpcClient

Methods

GetDefaultThirdPartyDataDeclaration(GetDefaultThirdPartyDataDeclarationRequest, CallSettings)

Returns the [DefaultThirdPartyDataDeclaration] for this network.

Declaration
public override DefaultThirdPartyDataDeclaration GetDefaultThirdPartyDataDeclaration(GetDefaultThirdPartyDataDeclarationRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetDefaultThirdPartyDataDeclarationRequest 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
DefaultThirdPartyDataDeclaration

The RPC response.

Overrides
NetworkServiceClient.GetDefaultThirdPartyDataDeclaration(GetDefaultThirdPartyDataDeclarationRequest, CallSettings)

GetDefaultThirdPartyDataDeclarationAsync(GetDefaultThirdPartyDataDeclarationRequest, CallSettings)

Returns the [DefaultThirdPartyDataDeclaration] for this network.

Declaration
public override Task<DefaultThirdPartyDataDeclaration> GetDefaultThirdPartyDataDeclarationAsync(GetDefaultThirdPartyDataDeclarationRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetDefaultThirdPartyDataDeclarationRequest 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<DefaultThirdPartyDataDeclaration>

A Task containing the RPC response.

Overrides
NetworkServiceClient.GetDefaultThirdPartyDataDeclarationAsync(GetDefaultThirdPartyDataDeclarationRequest, CallSettings)

GetNetwork(GetNetworkRequest, CallSettings)

Retrieves a Network object.

Declaration
public override Network GetNetwork(GetNetworkRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetNetworkRequest 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
Network

The RPC response.

Overrides
NetworkServiceClient.GetNetwork(GetNetworkRequest, CallSettings)

GetNetworkAsync(GetNetworkRequest, CallSettings)

Retrieves a Network object.

Declaration
public override Task<Network> GetNetworkAsync(GetNetworkRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetNetworkRequest 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<Network>

A Task containing the RPC response.

Overrides
NetworkServiceClient.GetNetworkAsync(GetNetworkRequest, CallSettings)

ListNetworks(ListNetworksRequest, CallSettings)

Retrieves all the networks the current user has access to.

Declaration
public override PagedEnumerable<ListNetworksResponse, Network> ListNetworks(ListNetworksRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListNetworksRequest 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
PagedEnumerable<ListNetworksResponse, Network>

A pageable sequence of Network resources.

Overrides
NetworkServiceClient.ListNetworks(ListNetworksRequest, CallSettings)

ListNetworksAsync(ListNetworksRequest, CallSettings)

Retrieves all the networks the current user has access to.

Declaration
public override PagedAsyncEnumerable<ListNetworksResponse, Network> ListNetworksAsync(ListNetworksRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListNetworksRequest 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
PagedAsyncEnumerable<ListNetworksResponse, Network>

A pageable asynchronous sequence of Network resources.

Overrides
NetworkServiceClient.ListNetworksAsync(ListNetworksRequest, CallSettings)

ProvisionTestNetwork(ProvisionTestNetworkRequest, CallSettings)

Provisions a test network associated with the current user. Only one test network can be provisioned per user.

Before the test network can be used, you must complete setup in the Ad Manager UI. If the test network's owner is a service account, you must add a non-service account user by calling UserService.CreateUser.

Test networks are limited in the following ways:

  • Test networks have a maximum of 10,000 objects per entity type.
  • Test networks cannot serve ads.
  • Reports on serving data have zero rows.
  • Forecast service results contain mock data.
  • Test networks do not have Ad Manager 360 or premium features enabled.
Declaration
public override Network ProvisionTestNetwork(ProvisionTestNetworkRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ProvisionTestNetworkRequest 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
Network

The RPC response.

Overrides
NetworkServiceClient.ProvisionTestNetwork(ProvisionTestNetworkRequest, CallSettings)

ProvisionTestNetworkAsync(ProvisionTestNetworkRequest, CallSettings)

Provisions a test network associated with the current user. Only one test network can be provisioned per user.

Before the test network can be used, you must complete setup in the Ad Manager UI. If the test network's owner is a service account, you must add a non-service account user by calling UserService.CreateUser.

Test networks are limited in the following ways:

  • Test networks have a maximum of 10,000 objects per entity type.
  • Test networks cannot serve ads.
  • Reports on serving data have zero rows.
  • Forecast service results contain mock data.
  • Test networks do not have Ad Manager 360 or premium features enabled.
Declaration
public override Task<Network> ProvisionTestNetworkAsync(ProvisionTestNetworkRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ProvisionTestNetworkRequest 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<Network>

A Task containing the RPC response.

Overrides
NetworkServiceClient.ProvisionTestNetworkAsync(ProvisionTestNetworkRequest, CallSettings)

UpdateNetwork(UpdateNetworkRequest, CallSettings)

Updates a Network object. Currently, only the network display name can be updated.

Declaration
public override Network UpdateNetwork(UpdateNetworkRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateNetworkRequest 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
Network

The RPC response.

Overrides
NetworkServiceClient.UpdateNetwork(UpdateNetworkRequest, CallSettings)

UpdateNetworkAsync(UpdateNetworkRequest, CallSettings)

Updates a Network object. Currently, only the network display name can be updated.

Declaration
public override Task<Network> UpdateNetworkAsync(UpdateNetworkRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateNetworkRequest 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<Network>

A Task containing the RPC response.

Overrides
NetworkServiceClient.UpdateNetworkAsync(UpdateNetworkRequest, CallSettings)
In this article
Back to top Generated by DocFX