Class NetworkService.NetworkServiceClient

Client for NetworkService

Inheritance

object

ClientBase

ClientBase<NetworkService.NetworkServiceClient>

NetworkService.NetworkServiceClient

Inherited Members

ClientBase<NetworkService.NetworkServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace: Google.Ads.AdManager.V1

Assembly: Google.Ads.AdManager.V1.dll

Syntax

public class NetworkService.NetworkServiceClient : ClientBase<NetworkService.NetworkServiceClient>

Constructors

NetworkServiceClient()

Protected parameterless constructor to allow creation of test doubles.

Declaration

protected NetworkServiceClient()

NetworkServiceClient(CallInvoker)

Creates a new client for NetworkService that uses a custom CallInvoker.

Declaration

public NetworkServiceClient(CallInvoker callInvoker)

Parameters

Type	Name	Description
CallInvoker	callInvoker	The callInvoker to use to make remote calls.

NetworkServiceClient(ChannelBase)

Creates a new client for NetworkService

Declaration

public NetworkServiceClient(ChannelBase channel)

Parameters

Type	Name	Description
ChannelBase	channel	The channel to use to make remote calls.

NetworkServiceClient(ClientBaseConfiguration)

Protected constructor to allow creation of configured clients.

Declaration

protected NetworkServiceClient(ClientBase.ClientBaseConfiguration configuration)

Parameters

Type	Name	Description
ClientBase.ClientBaseConfiguration	configuration	The client configuration.

Methods

GetDefaultThirdPartyDataDeclaration(GetDefaultThirdPartyDataDeclarationRequest, CallOptions)

Returns the [DefaultThirdPartyDataDeclaration] for this network.

Declaration

public virtual DefaultThirdPartyDataDeclaration GetDefaultThirdPartyDataDeclaration(GetDefaultThirdPartyDataDeclarationRequest request, CallOptions options)

Parameters

Type	Name	Description
GetDefaultThirdPartyDataDeclarationRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
DefaultThirdPartyDataDeclaration	The response received from the server.

GetDefaultThirdPartyDataDeclaration(GetDefaultThirdPartyDataDeclarationRequest, Metadata, DateTime?, CancellationToken)

Returns the [DefaultThirdPartyDataDeclaration] for this network.

Declaration

public virtual DefaultThirdPartyDataDeclaration GetDefaultThirdPartyDataDeclaration(GetDefaultThirdPartyDataDeclarationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
GetDefaultThirdPartyDataDeclarationRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
DefaultThirdPartyDataDeclaration	The response received from the server.

GetDefaultThirdPartyDataDeclarationAsync(GetDefaultThirdPartyDataDeclarationRequest, CallOptions)

Returns the [DefaultThirdPartyDataDeclaration] for this network.

Declaration

public virtual AsyncUnaryCall<DefaultThirdPartyDataDeclaration> GetDefaultThirdPartyDataDeclarationAsync(GetDefaultThirdPartyDataDeclarationRequest request, CallOptions options)

Parameters

Type	Name	Description
GetDefaultThirdPartyDataDeclarationRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<DefaultThirdPartyDataDeclaration>	The call object.

GetDefaultThirdPartyDataDeclarationAsync(GetDefaultThirdPartyDataDeclarationRequest, Metadata, DateTime?, CancellationToken)

Returns the [DefaultThirdPartyDataDeclaration] for this network.

Declaration

public virtual AsyncUnaryCall<DefaultThirdPartyDataDeclaration> GetDefaultThirdPartyDataDeclarationAsync(GetDefaultThirdPartyDataDeclarationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
GetDefaultThirdPartyDataDeclarationRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<DefaultThirdPartyDataDeclaration>	The call object.

GetNetwork(GetNetworkRequest, CallOptions)

Retrieves a Network object.

Declaration

public virtual Network GetNetwork(GetNetworkRequest request, CallOptions options)

Parameters

Type	Name	Description
GetNetworkRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
Network	The response received from the server.

GetNetwork(GetNetworkRequest, Metadata, DateTime?, CancellationToken)

Retrieves a Network object.

Declaration

public virtual Network GetNetwork(GetNetworkRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
GetNetworkRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
Network	The response received from the server.

GetNetworkAsync(GetNetworkRequest, CallOptions)

Retrieves a Network object.

Declaration

public virtual AsyncUnaryCall<Network> GetNetworkAsync(GetNetworkRequest request, CallOptions options)

Parameters

Type	Name	Description
GetNetworkRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<Network>	The call object.

GetNetworkAsync(GetNetworkRequest, Metadata, DateTime?, CancellationToken)

Retrieves a Network object.

Declaration

public virtual AsyncUnaryCall<Network> GetNetworkAsync(GetNetworkRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
GetNetworkRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<Network>	The call object.

ListNetworks(ListNetworksRequest, CallOptions)

Retrieves all the networks the current user has access to.

Declaration

public virtual ListNetworksResponse ListNetworks(ListNetworksRequest request, CallOptions options)

Parameters

Type	Name	Description
ListNetworksRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
ListNetworksResponse	The response received from the server.

ListNetworks(ListNetworksRequest, Metadata, DateTime?, CancellationToken)

Retrieves all the networks the current user has access to.

Declaration

public virtual ListNetworksResponse ListNetworks(ListNetworksRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListNetworksRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
ListNetworksResponse	The response received from the server.

ListNetworksAsync(ListNetworksRequest, CallOptions)

Retrieves all the networks the current user has access to.

Declaration

public virtual AsyncUnaryCall<ListNetworksResponse> ListNetworksAsync(ListNetworksRequest request, CallOptions options)

Parameters

Type	Name	Description
ListNetworksRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<ListNetworksResponse>	The call object.

ListNetworksAsync(ListNetworksRequest, Metadata, DateTime?, CancellationToken)

Retrieves all the networks the current user has access to.

Declaration

public virtual AsyncUnaryCall<ListNetworksResponse> ListNetworksAsync(ListNetworksRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListNetworksRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<ListNetworksResponse>	The call object.

NewInstance(ClientBaseConfiguration)

Creates a new instance of client from given ClientBaseConfiguration.

Declaration

protected override NetworkService.NetworkServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Parameters

Type	Name	Description
ClientBase.ClientBaseConfiguration	configuration

Returns

Type	Description
NetworkService.NetworkServiceClient

Overrides

Grpc.Core.ClientBase<Google.Ads.AdManager.V1.NetworkService.NetworkServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

ProvisionTestNetwork(ProvisionTestNetworkRequest, CallOptions)

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 virtual Network ProvisionTestNetwork(ProvisionTestNetworkRequest request, CallOptions options)

Parameters

Type	Name	Description
ProvisionTestNetworkRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
Network	The response received from the server.

ProvisionTestNetwork(ProvisionTestNetworkRequest, Metadata, DateTime?, CancellationToken)

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 virtual Network ProvisionTestNetwork(ProvisionTestNetworkRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ProvisionTestNetworkRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
Network	The response received from the server.

ProvisionTestNetworkAsync(ProvisionTestNetworkRequest, CallOptions)

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 virtual AsyncUnaryCall<Network> ProvisionTestNetworkAsync(ProvisionTestNetworkRequest request, CallOptions options)

Parameters

Type	Name	Description
ProvisionTestNetworkRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<Network>	The call object.

ProvisionTestNetworkAsync(ProvisionTestNetworkRequest, Metadata, DateTime?, CancellationToken)

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 virtual AsyncUnaryCall<Network> ProvisionTestNetworkAsync(ProvisionTestNetworkRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ProvisionTestNetworkRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<Network>	The call object.

UpdateNetwork(UpdateNetworkRequest, CallOptions)

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

Declaration

public virtual Network UpdateNetwork(UpdateNetworkRequest request, CallOptions options)

Parameters

Type	Name	Description
UpdateNetworkRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
Network	The response received from the server.

UpdateNetwork(UpdateNetworkRequest, Metadata, DateTime?, CancellationToken)

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

Declaration

public virtual Network UpdateNetwork(UpdateNetworkRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
UpdateNetworkRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
Network	The response received from the server.

UpdateNetworkAsync(UpdateNetworkRequest, CallOptions)

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

Declaration

public virtual AsyncUnaryCall<Network> UpdateNetworkAsync(UpdateNetworkRequest request, CallOptions options)

Parameters

Type	Name	Description
UpdateNetworkRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<Network>	The call object.

UpdateNetworkAsync(UpdateNetworkRequest, Metadata, DateTime?, CancellationToken)

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

Declaration

public virtual AsyncUnaryCall<Network> UpdateNetworkAsync(UpdateNetworkRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
UpdateNetworkRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<Network>	The call object.