Class PartnerServiceClient

PartnerService client wrapper, for convenient use.

Inheritance

object

PartnerServiceClient

PartnerServiceClientImpl

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace: Google.Ads.AdManager.V1

Assembly: Google.Ads.AdManager.V1.dll

Syntax

public abstract class PartnerServiceClient

Remarks

Provides methods for handling [Partner][google.ads.admanager.v1.Partner] objects.

Properties

DefaultEndpoint

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

Declaration

public static string DefaultEndpoint { get; }

Property Value

Type	Description
string

DefaultScopes

The default PartnerService scopes.

Declaration

public static IReadOnlyList<string> DefaultScopes { get; }

Property Value

Type	Description
IReadOnlyList<string>

Remarks

The default PartnerService scopes are:

• https://www.googleapis.com/auth/admanager
• https://www.googleapis.com/auth/admanager.readonly

GrpcClient

The underlying gRPC PartnerService client

Declaration

public virtual PartnerService.PartnerServiceClient GrpcClient { get; }

Property Value

Type	Description
PartnerService.PartnerServiceClient

ServiceMetadata

The service metadata associated with this client type.

Declaration

public static ServiceMetadata ServiceMetadata { get; }

Property Value

Type	Description
ServiceMetadata

Methods

BatchUpdatePartners(BatchUpdatePartnersRequest, CallSettings)

Batch updates [Partner][google.ads.admanager.v1.Partner] objects.

Declaration

public virtual BatchUpdatePartnersResponse BatchUpdatePartners(BatchUpdatePartnersRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
BatchUpdatePartnersRequest	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
BatchUpdatePartnersResponse	The RPC response.

Sample code

// Create client
PartnerServiceClient partnerServiceClient = PartnerServiceClient.Create();
// Initialize request argument(s)
BatchUpdatePartnersRequest request = new BatchUpdatePartnersRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    Requests =
    {
        new UpdatePartnerRequest(),
    },
};
// Make the request
BatchUpdatePartnersResponse response = partnerServiceClient.BatchUpdatePartners(request);

BatchUpdatePartners(NetworkName, IEnumerable<UpdatePartnerRequest>, CallSettings)

Batch updates [Partner][google.ads.admanager.v1.Partner] objects.

Declaration

public virtual BatchUpdatePartnersResponse BatchUpdatePartners(NetworkName parent, IEnumerable<UpdatePartnerRequest> requests, CallSettings callSettings = null)

Parameters

Type	Name	Description
NetworkName	parent	Required. The parent resource where [Partner][google.ads.admanager.v1.Partner]s will be updated. Format: networks/{network_code} The parent field in the [UpdatePartnerRequest][google.ads.admanager.v1.UpdatePartnerRequest] must match this field.
IEnumerable<UpdatePartnerRequest>	requests	Required. The [Partner][google.ads.admanager.v1.Partner] objects to update. A maximum of 100 objects can be updated in a batch.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
BatchUpdatePartnersResponse	The RPC response.

Sample code

// Create client
PartnerServiceClient partnerServiceClient = PartnerServiceClient.Create();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
IEnumerable<UpdatePartnerRequest> requests = new UpdatePartnerRequest[]
{
    new UpdatePartnerRequest(),
};
// Make the request
BatchUpdatePartnersResponse response = partnerServiceClient.BatchUpdatePartners(parent, requests);

BatchUpdatePartners(string, IEnumerable<UpdatePartnerRequest>, CallSettings)

Batch updates [Partner][google.ads.admanager.v1.Partner] objects.

Declaration

public virtual BatchUpdatePartnersResponse BatchUpdatePartners(string parent, IEnumerable<UpdatePartnerRequest> requests, CallSettings callSettings = null)

Parameters

Type	Name	Description
string	parent	Required. The parent resource where [Partner][google.ads.admanager.v1.Partner]s will be updated. Format: networks/{network_code} The parent field in the [UpdatePartnerRequest][google.ads.admanager.v1.UpdatePartnerRequest] must match this field.
IEnumerable<UpdatePartnerRequest>	requests	Required. The [Partner][google.ads.admanager.v1.Partner] objects to update. A maximum of 100 objects can be updated in a batch.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
BatchUpdatePartnersResponse	The RPC response.

Sample code

// Create client
PartnerServiceClient partnerServiceClient = PartnerServiceClient.Create();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
IEnumerable<UpdatePartnerRequest> requests = new UpdatePartnerRequest[]
{
    new UpdatePartnerRequest(),
};
// Make the request
BatchUpdatePartnersResponse response = partnerServiceClient.BatchUpdatePartners(parent, requests);

BatchUpdatePartnersAsync(BatchUpdatePartnersRequest, CallSettings)

Batch updates [Partner][google.ads.admanager.v1.Partner] objects.

Declaration

public virtual Task<BatchUpdatePartnersResponse> BatchUpdatePartnersAsync(BatchUpdatePartnersRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
BatchUpdatePartnersRequest	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<BatchUpdatePartnersResponse>	A Task containing the RPC response.

Sample code

// Create client
PartnerServiceClient partnerServiceClient = await PartnerServiceClient.CreateAsync();
// Initialize request argument(s)
BatchUpdatePartnersRequest request = new BatchUpdatePartnersRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    Requests =
    {
        new UpdatePartnerRequest(),
    },
};
// Make the request
BatchUpdatePartnersResponse response = await partnerServiceClient.BatchUpdatePartnersAsync(request);

BatchUpdatePartnersAsync(BatchUpdatePartnersRequest, CancellationToken)

Batch updates [Partner][google.ads.admanager.v1.Partner] objects.

Declaration

public virtual Task<BatchUpdatePartnersResponse> BatchUpdatePartnersAsync(BatchUpdatePartnersRequest request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
BatchUpdatePartnersRequest	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<BatchUpdatePartnersResponse>	A Task containing the RPC response.

Sample code

// Create client
PartnerServiceClient partnerServiceClient = await PartnerServiceClient.CreateAsync();
// Initialize request argument(s)
BatchUpdatePartnersRequest request = new BatchUpdatePartnersRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    Requests =
    {
        new UpdatePartnerRequest(),
    },
};
// Make the request
BatchUpdatePartnersResponse response = await partnerServiceClient.BatchUpdatePartnersAsync(request);

BatchUpdatePartnersAsync(NetworkName, IEnumerable<UpdatePartnerRequest>, CallSettings)

Batch updates [Partner][google.ads.admanager.v1.Partner] objects.

Declaration

public virtual Task<BatchUpdatePartnersResponse> BatchUpdatePartnersAsync(NetworkName parent, IEnumerable<UpdatePartnerRequest> requests, CallSettings callSettings = null)

Parameters

Type	Name	Description
NetworkName	parent	Required. The parent resource where [Partner][google.ads.admanager.v1.Partner]s will be updated. Format: networks/{network_code} The parent field in the [UpdatePartnerRequest][google.ads.admanager.v1.UpdatePartnerRequest] must match this field.
IEnumerable<UpdatePartnerRequest>	requests	Required. The [Partner][google.ads.admanager.v1.Partner] objects to update. A maximum of 100 objects can be updated in a batch.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

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

Sample code

// Create client
PartnerServiceClient partnerServiceClient = await PartnerServiceClient.CreateAsync();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
IEnumerable<UpdatePartnerRequest> requests = new UpdatePartnerRequest[]
{
    new UpdatePartnerRequest(),
};
// Make the request
BatchUpdatePartnersResponse response = await partnerServiceClient.BatchUpdatePartnersAsync(parent, requests);

BatchUpdatePartnersAsync(NetworkName, IEnumerable<UpdatePartnerRequest>, CancellationToken)

Batch updates [Partner][google.ads.admanager.v1.Partner] objects.

Declaration

public virtual Task<BatchUpdatePartnersResponse> BatchUpdatePartnersAsync(NetworkName parent, IEnumerable<UpdatePartnerRequest> requests, CancellationToken cancellationToken)

Parameters

Type	Name	Description
NetworkName	parent	Required. The parent resource where [Partner][google.ads.admanager.v1.Partner]s will be updated. Format: networks/{network_code} The parent field in the [UpdatePartnerRequest][google.ads.admanager.v1.UpdatePartnerRequest] must match this field.
IEnumerable<UpdatePartnerRequest>	requests	Required. The [Partner][google.ads.admanager.v1.Partner] objects to update. A maximum of 100 objects can be updated in a batch.
CancellationToken	cancellationToken	A CancellationToken to use for this RPC.

Returns

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

Sample code

// Create client
PartnerServiceClient partnerServiceClient = await PartnerServiceClient.CreateAsync();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
IEnumerable<UpdatePartnerRequest> requests = new UpdatePartnerRequest[]
{
    new UpdatePartnerRequest(),
};
// Make the request
BatchUpdatePartnersResponse response = await partnerServiceClient.BatchUpdatePartnersAsync(parent, requests);

BatchUpdatePartnersAsync(string, IEnumerable<UpdatePartnerRequest>, CallSettings)

Batch updates [Partner][google.ads.admanager.v1.Partner] objects.

Declaration

public virtual Task<BatchUpdatePartnersResponse> BatchUpdatePartnersAsync(string parent, IEnumerable<UpdatePartnerRequest> requests, CallSettings callSettings = null)

Parameters

Type	Name	Description
string	parent	Required. The parent resource where [Partner][google.ads.admanager.v1.Partner]s will be updated. Format: networks/{network_code} The parent field in the [UpdatePartnerRequest][google.ads.admanager.v1.UpdatePartnerRequest] must match this field.
IEnumerable<UpdatePartnerRequest>	requests	Required. The [Partner][google.ads.admanager.v1.Partner] objects to update. A maximum of 100 objects can be updated in a batch.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

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

Sample code

// Create client
PartnerServiceClient partnerServiceClient = await PartnerServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
IEnumerable<UpdatePartnerRequest> requests = new UpdatePartnerRequest[]
{
    new UpdatePartnerRequest(),
};
// Make the request
BatchUpdatePartnersResponse response = await partnerServiceClient.BatchUpdatePartnersAsync(parent, requests);

BatchUpdatePartnersAsync(string, IEnumerable<UpdatePartnerRequest>, CancellationToken)

Batch updates [Partner][google.ads.admanager.v1.Partner] objects.

Declaration

public virtual Task<BatchUpdatePartnersResponse> BatchUpdatePartnersAsync(string parent, IEnumerable<UpdatePartnerRequest> requests, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	parent	Required. The parent resource where [Partner][google.ads.admanager.v1.Partner]s will be updated. Format: networks/{network_code} The parent field in the [UpdatePartnerRequest][google.ads.admanager.v1.UpdatePartnerRequest] must match this field.
IEnumerable<UpdatePartnerRequest>	requests	Required. The [Partner][google.ads.admanager.v1.Partner] objects to update. A maximum of 100 objects can be updated in a batch.
CancellationToken	cancellationToken	A CancellationToken to use for this RPC.

Returns

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

Sample code

// Create client
PartnerServiceClient partnerServiceClient = await PartnerServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
IEnumerable<UpdatePartnerRequest> requests = new UpdatePartnerRequest[]
{
    new UpdatePartnerRequest(),
};
// Make the request
BatchUpdatePartnersResponse response = await partnerServiceClient.BatchUpdatePartnersAsync(parent, requests);

Create()

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

Declaration

public static PartnerServiceClient Create()

Returns

Type	Description
PartnerServiceClient	The created PartnerServiceClient.

CreateAsync(CancellationToken)

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

Declaration

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

Parameters

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

Returns

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

GetPartner(GetPartnerRequest, CallSettings)

Retrieves a [Partner][google.ads.admanager.v1.Partner] object.

Declaration

public virtual Partner GetPartner(GetPartnerRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
GetPartnerRequest	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
Partner	The RPC response.

Sample code

// Create client
PartnerServiceClient partnerServiceClient = PartnerServiceClient.Create();
// Initialize request argument(s)
GetPartnerRequest request = new GetPartnerRequest
{
    PartnerName = PartnerName.FromNetworkCodePartner("[NETWORK_CODE]", "[PARTNER]"),
};
// Make the request
Partner response = partnerServiceClient.GetPartner(request);

GetPartner(PartnerName, CallSettings)

Retrieves a [Partner][google.ads.admanager.v1.Partner] object.

Declaration

public virtual Partner GetPartner(PartnerName name, CallSettings callSettings = null)

Parameters

Type	Name	Description
PartnerName	name	Required. The resource name of the [Partner][google.ads.admanager.v1.Partner]. Format: networks/{network_code}/partners/{partner_id}
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
Partner	The RPC response.

Sample code

// Create client
PartnerServiceClient partnerServiceClient = PartnerServiceClient.Create();
// Initialize request argument(s)
PartnerName name = PartnerName.FromNetworkCodePartner("[NETWORK_CODE]", "[PARTNER]");
// Make the request
Partner response = partnerServiceClient.GetPartner(name);

GetPartner(string, CallSettings)

Retrieves a [Partner][google.ads.admanager.v1.Partner] object.

Declaration

public virtual Partner GetPartner(string name, CallSettings callSettings = null)

Parameters

Type	Name	Description
string	name	Required. The resource name of the [Partner][google.ads.admanager.v1.Partner]. Format: networks/{network_code}/partners/{partner_id}
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
Partner	The RPC response.

Sample code

// Create client
PartnerServiceClient partnerServiceClient = PartnerServiceClient.Create();
// Initialize request argument(s)
string name = "networks/[NETWORK_CODE]/partners/[PARTNER]";
// Make the request
Partner response = partnerServiceClient.GetPartner(name);

GetPartnerAsync(GetPartnerRequest, CallSettings)

Retrieves a [Partner][google.ads.admanager.v1.Partner] object.

Declaration

public virtual Task<Partner> GetPartnerAsync(GetPartnerRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
GetPartnerRequest	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<Partner>	A Task containing the RPC response.

Sample code

// Create client
PartnerServiceClient partnerServiceClient = await PartnerServiceClient.CreateAsync();
// Initialize request argument(s)
GetPartnerRequest request = new GetPartnerRequest
{
    PartnerName = PartnerName.FromNetworkCodePartner("[NETWORK_CODE]", "[PARTNER]"),
};
// Make the request
Partner response = await partnerServiceClient.GetPartnerAsync(request);

GetPartnerAsync(GetPartnerRequest, CancellationToken)

Retrieves a [Partner][google.ads.admanager.v1.Partner] object.

Declaration

public virtual Task<Partner> GetPartnerAsync(GetPartnerRequest request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
GetPartnerRequest	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<Partner>	A Task containing the RPC response.

Sample code

// Create client
PartnerServiceClient partnerServiceClient = await PartnerServiceClient.CreateAsync();
// Initialize request argument(s)
GetPartnerRequest request = new GetPartnerRequest
{
    PartnerName = PartnerName.FromNetworkCodePartner("[NETWORK_CODE]", "[PARTNER]"),
};
// Make the request
Partner response = await partnerServiceClient.GetPartnerAsync(request);

GetPartnerAsync(PartnerName, CallSettings)

Retrieves a [Partner][google.ads.admanager.v1.Partner] object.

Declaration

public virtual Task<Partner> GetPartnerAsync(PartnerName name, CallSettings callSettings = null)

Parameters

Type	Name	Description
PartnerName	name	Required. The resource name of the [Partner][google.ads.admanager.v1.Partner]. Format: networks/{network_code}/partners/{partner_id}
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

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

Sample code

// Create client
PartnerServiceClient partnerServiceClient = await PartnerServiceClient.CreateAsync();
// Initialize request argument(s)
PartnerName name = PartnerName.FromNetworkCodePartner("[NETWORK_CODE]", "[PARTNER]");
// Make the request
Partner response = await partnerServiceClient.GetPartnerAsync(name);

GetPartnerAsync(PartnerName, CancellationToken)

Retrieves a [Partner][google.ads.admanager.v1.Partner] object.

Declaration

public virtual Task<Partner> GetPartnerAsync(PartnerName name, CancellationToken cancellationToken)

Parameters

Type	Name	Description
PartnerName	name	Required. The resource name of the [Partner][google.ads.admanager.v1.Partner]. Format: networks/{network_code}/partners/{partner_id}
CancellationToken	cancellationToken	A CancellationToken to use for this RPC.

Returns

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

Sample code

// Create client
PartnerServiceClient partnerServiceClient = await PartnerServiceClient.CreateAsync();
// Initialize request argument(s)
PartnerName name = PartnerName.FromNetworkCodePartner("[NETWORK_CODE]", "[PARTNER]");
// Make the request
Partner response = await partnerServiceClient.GetPartnerAsync(name);

GetPartnerAsync(string, CallSettings)

Retrieves a [Partner][google.ads.admanager.v1.Partner] object.

Declaration

public virtual Task<Partner> GetPartnerAsync(string name, CallSettings callSettings = null)

Parameters

Type	Name	Description
string	name	Required. The resource name of the [Partner][google.ads.admanager.v1.Partner]. Format: networks/{network_code}/partners/{partner_id}
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

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

Sample code

// Create client
PartnerServiceClient partnerServiceClient = await PartnerServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "networks/[NETWORK_CODE]/partners/[PARTNER]";
// Make the request
Partner response = await partnerServiceClient.GetPartnerAsync(name);

GetPartnerAsync(string, CancellationToken)

Retrieves a [Partner][google.ads.admanager.v1.Partner] object.

Declaration

public virtual Task<Partner> GetPartnerAsync(string name, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	name	Required. The resource name of the [Partner][google.ads.admanager.v1.Partner]. Format: networks/{network_code}/partners/{partner_id}
CancellationToken	cancellationToken	A CancellationToken to use for this RPC.

Returns

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

Sample code

// Create client
PartnerServiceClient partnerServiceClient = await PartnerServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "networks/[NETWORK_CODE]/partners/[PARTNER]";
// Make the request
Partner response = await partnerServiceClient.GetPartnerAsync(name);

ListPartners(ListPartnersRequest, CallSettings)

Lists [Partner][google.ads.admanager.v1.Partner] objects.

Declaration

public virtual PagedEnumerable<ListPartnersResponse, Partner> ListPartners(ListPartnersRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
ListPartnersRequest	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<ListPartnersResponse, Partner>	A pageable sequence of Partner resources.

Sample code

// Create client
PartnerServiceClient partnerServiceClient = PartnerServiceClient.Create();
// Initialize request argument(s)
ListPartnersRequest request = new ListPartnersRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    Filter = "",
    OrderBy = "",
    Skip = 0,
};
// Make the request
PagedEnumerable<ListPartnersResponse, Partner> response = partnerServiceClient.ListPartners(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (Partner item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListPartnersResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Partner item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Partner> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Partner item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListPartners(NetworkName, string, int?, CallSettings)

Lists [Partner][google.ads.admanager.v1.Partner] objects.

Declaration

public virtual PagedEnumerable<ListPartnersResponse, Partner> ListPartners(NetworkName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Parameters

Type	Name	Description
NetworkName	parent	Required. The parent, which owns this collection of [Partner][google.ads.admanager.v1.Partner]s. Format: networks/{network_code}
string	pageToken	The token returned from the previous request. A value of null or an empty string retrieves the first page.
int?	pageSize	The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
PagedEnumerable<ListPartnersResponse, Partner>	A pageable sequence of Partner resources.

Sample code

// Create client
PartnerServiceClient partnerServiceClient = PartnerServiceClient.Create();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
// Make the request
PagedEnumerable<ListPartnersResponse, Partner> response = partnerServiceClient.ListPartners(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Partner item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListPartnersResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Partner item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Partner> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Partner item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListPartners(string, string, int?, CallSettings)

Lists [Partner][google.ads.admanager.v1.Partner] objects.

Declaration

public virtual PagedEnumerable<ListPartnersResponse, Partner> ListPartners(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Parameters

Type	Name	Description
string	parent	Required. The parent, which owns this collection of [Partner][google.ads.admanager.v1.Partner]s. Format: networks/{network_code}
string	pageToken	The token returned from the previous request. A value of null or an empty string retrieves the first page.
int?	pageSize	The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
PagedEnumerable<ListPartnersResponse, Partner>	A pageable sequence of Partner resources.

Sample code

// Create client
PartnerServiceClient partnerServiceClient = PartnerServiceClient.Create();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
// Make the request
PagedEnumerable<ListPartnersResponse, Partner> response = partnerServiceClient.ListPartners(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Partner item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListPartnersResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Partner item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Partner> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Partner item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListPartnersAsync(ListPartnersRequest, CallSettings)

Lists [Partner][google.ads.admanager.v1.Partner] objects.

Declaration

public virtual PagedAsyncEnumerable<ListPartnersResponse, Partner> ListPartnersAsync(ListPartnersRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
ListPartnersRequest	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<ListPartnersResponse, Partner>	A pageable asynchronous sequence of Partner resources.

Sample code

// Create client
PartnerServiceClient partnerServiceClient = await PartnerServiceClient.CreateAsync();
// Initialize request argument(s)
ListPartnersRequest request = new ListPartnersRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    Filter = "",
    OrderBy = "",
    Skip = 0,
};
// Make the request
PagedAsyncEnumerable<ListPartnersResponse, Partner> response = partnerServiceClient.ListPartnersAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await foreach (Partner item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListPartnersResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Partner item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Partner> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Partner item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListPartnersAsync(NetworkName, string, int?, CallSettings)

Lists [Partner][google.ads.admanager.v1.Partner] objects.

Declaration

public virtual PagedAsyncEnumerable<ListPartnersResponse, Partner> ListPartnersAsync(NetworkName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Parameters

Type	Name	Description
NetworkName	parent	Required. The parent, which owns this collection of [Partner][google.ads.admanager.v1.Partner]s. Format: networks/{network_code}
string	pageToken	The token returned from the previous request. A value of null or an empty string retrieves the first page.
int?	pageSize	The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
PagedAsyncEnumerable<ListPartnersResponse, Partner>	A pageable asynchronous sequence of Partner resources.

Sample code

// Create client
PartnerServiceClient partnerServiceClient = await PartnerServiceClient.CreateAsync();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
// Make the request
PagedAsyncEnumerable<ListPartnersResponse, Partner> response = partnerServiceClient.ListPartnersAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await foreach (Partner item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListPartnersResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Partner item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Partner> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Partner item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListPartnersAsync(string, string, int?, CallSettings)

Lists [Partner][google.ads.admanager.v1.Partner] objects.

Declaration

public virtual PagedAsyncEnumerable<ListPartnersResponse, Partner> ListPartnersAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Parameters

Type	Name	Description
string	parent	Required. The parent, which owns this collection of [Partner][google.ads.admanager.v1.Partner]s. Format: networks/{network_code}
string	pageToken	The token returned from the previous request. A value of null or an empty string retrieves the first page.
int?	pageSize	The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
PagedAsyncEnumerable<ListPartnersResponse, Partner>	A pageable asynchronous sequence of Partner resources.

Sample code

// Create client
PartnerServiceClient partnerServiceClient = await PartnerServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
// Make the request
PagedAsyncEnumerable<ListPartnersResponse, Partner> response = partnerServiceClient.ListPartnersAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await foreach (Partner item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListPartnersResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Partner item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Partner> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Partner item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

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.

UpdatePartner(Partner, FieldMask, CallSettings)

Updates a [Partner][google.ads.admanager.v1.Partner] object.

Declaration

public virtual Partner UpdatePartner(Partner partner, FieldMask updateMask, CallSettings callSettings = null)

Parameters

Type	Name	Description
Partner	partner	Required. The [Partner][google.ads.admanager.v1.Partner] to update. The [Partner][google.ads.admanager.v1.Partner]'s name is used to identify the [Partner][google.ads.admanager.v1.Partner] to update.
FieldMask	updateMask	Optional. The list of fields to update.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
Partner	The RPC response.

Sample code

// Create client
PartnerServiceClient partnerServiceClient = PartnerServiceClient.Create();
// Initialize request argument(s)
Partner partner = new Partner();
FieldMask updateMask = new FieldMask();
// Make the request
Partner response = partnerServiceClient.UpdatePartner(partner, updateMask);

UpdatePartner(UpdatePartnerRequest, CallSettings)

Updates a [Partner][google.ads.admanager.v1.Partner] object.

Declaration

public virtual Partner UpdatePartner(UpdatePartnerRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
UpdatePartnerRequest	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
Partner	The RPC response.

Sample code

// Create client
PartnerServiceClient partnerServiceClient = PartnerServiceClient.Create();
// Initialize request argument(s)
UpdatePartnerRequest request = new UpdatePartnerRequest
{
    Partner = new Partner(),
    UpdateMask = new FieldMask(),
};
// Make the request
Partner response = partnerServiceClient.UpdatePartner(request);

UpdatePartnerAsync(Partner, FieldMask, CallSettings)

Updates a [Partner][google.ads.admanager.v1.Partner] object.

Declaration

public virtual Task<Partner> UpdatePartnerAsync(Partner partner, FieldMask updateMask, CallSettings callSettings = null)

Parameters

Type	Name	Description
Partner	partner	Required. The [Partner][google.ads.admanager.v1.Partner] to update. The [Partner][google.ads.admanager.v1.Partner]'s name is used to identify the [Partner][google.ads.admanager.v1.Partner] to update.
FieldMask	updateMask	Optional. The list of fields to update.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

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

Sample code

// Create client
PartnerServiceClient partnerServiceClient = await PartnerServiceClient.CreateAsync();
// Initialize request argument(s)
Partner partner = new Partner();
FieldMask updateMask = new FieldMask();
// Make the request
Partner response = await partnerServiceClient.UpdatePartnerAsync(partner, updateMask);

UpdatePartnerAsync(Partner, FieldMask, CancellationToken)

Updates a [Partner][google.ads.admanager.v1.Partner] object.

Declaration

public virtual Task<Partner> UpdatePartnerAsync(Partner partner, FieldMask updateMask, CancellationToken cancellationToken)

Parameters

Type	Name	Description
Partner	partner	Required. The [Partner][google.ads.admanager.v1.Partner] to update. The [Partner][google.ads.admanager.v1.Partner]'s name is used to identify the [Partner][google.ads.admanager.v1.Partner] to update.
FieldMask	updateMask	Optional. The list of fields to update.
CancellationToken	cancellationToken	A CancellationToken to use for this RPC.

Returns

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

Sample code

// Create client
PartnerServiceClient partnerServiceClient = await PartnerServiceClient.CreateAsync();
// Initialize request argument(s)
Partner partner = new Partner();
FieldMask updateMask = new FieldMask();
// Make the request
Partner response = await partnerServiceClient.UpdatePartnerAsync(partner, updateMask);

UpdatePartnerAsync(UpdatePartnerRequest, CallSettings)

Updates a [Partner][google.ads.admanager.v1.Partner] object.

Declaration

public virtual Task<Partner> UpdatePartnerAsync(UpdatePartnerRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
UpdatePartnerRequest	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<Partner>	A Task containing the RPC response.

Sample code

// Create client
PartnerServiceClient partnerServiceClient = await PartnerServiceClient.CreateAsync();
// Initialize request argument(s)
UpdatePartnerRequest request = new UpdatePartnerRequest
{
    Partner = new Partner(),
    UpdateMask = new FieldMask(),
};
// Make the request
Partner response = await partnerServiceClient.UpdatePartnerAsync(request);

UpdatePartnerAsync(UpdatePartnerRequest, CancellationToken)

Updates a [Partner][google.ads.admanager.v1.Partner] object.

Declaration

public virtual Task<Partner> UpdatePartnerAsync(UpdatePartnerRequest request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
UpdatePartnerRequest	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<Partner>	A Task containing the RPC response.

Sample code

// Create client
PartnerServiceClient partnerServiceClient = await PartnerServiceClient.CreateAsync();
// Initialize request argument(s)
UpdatePartnerRequest request = new UpdatePartnerRequest
{
    Partner = new Partner(),
    UpdateMask = new FieldMask(),
};
// Make the request
Partner response = await partnerServiceClient.UpdatePartnerAsync(request);