Class PlacementName

Resource name for the Placement resource.

Inheritance

object

PlacementName

Implements

IResourceName

IEquatable<PlacementName>

Inherited Members

object.GetType()

Namespace: Google.Ads.AdManager.V1

Assembly: Google.Ads.AdManager.V1.dll

Syntax

public sealed class PlacementName : IResourceName, IEquatable<PlacementName>

Constructors

PlacementName(string, string)

Constructs a new instance of a PlacementName class from the component parts of pattern networks/{network_code}/placements/{placement}

Declaration

public PlacementName(string networkCodeId, string placementId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	placementId	The Placement ID. Must not be null or empty.

Properties

IsKnownPattern

Whether this instance contains a resource name with a known pattern.

Declaration

public bool IsKnownPattern { get; }

Property Value

Type	Description
bool

Implements

IResourceName.IsKnownPattern

NetworkCodeId

The NetworkCode ID. Will not be null, unless this instance contains an unparsed resource name.

Declaration

public string NetworkCodeId { get; }

Property Value

Type	Description
string

PlacementId

The Placement ID. Will not be null, unless this instance contains an unparsed resource name.

Declaration

public string PlacementId { get; }

Property Value

Type	Description
string

Type

The PlacementName.ResourceNameType of the contained resource name.

Declaration

public PlacementName.ResourceNameType Type { get; }

Property Value

Type	Description
PlacementName.ResourceNameType

UnparsedResource

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Declaration

public UnparsedResourceName UnparsedResource { get; }

Property Value

Type	Description
UnparsedResourceName

Methods

Format(string, string)

Formats the IDs into the string representation of this PlacementName with pattern networks/{network_code}/placements/{placement}.

Declaration

public static string Format(string networkCodeId, string placementId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	placementId	The Placement ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this PlacementName with pattern networks/{network_code}/placements/{placement}.

FormatNetworkCodePlacement(string, string)

Formats the IDs into the string representation of this PlacementName with pattern networks/{network_code}/placements/{placement}.

Declaration

public static string FormatNetworkCodePlacement(string networkCodeId, string placementId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	placementId	The Placement ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this PlacementName with pattern networks/{network_code}/placements/{placement}.

FromNetworkCodePlacement(string, string)

Creates a PlacementName with the pattern networks/{network_code}/placements/{placement} .

Declaration

public static PlacementName FromNetworkCodePlacement(string networkCodeId, string placementId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	placementId	The Placement ID. Must not be null or empty.

Returns

Type	Description
PlacementName	A new instance of PlacementName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

Creates a PlacementName containing an unparsed resource name.

Declaration

public static PlacementName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

Type	Name	Description
UnparsedResourceName	unparsedResourceName	The unparsed resource name. Must not be null.

Returns

Type	Description
PlacementName	A new instance of PlacementName containing the provided unparsedResourceName.

GetHashCode()

Returns a hash code for this resource name.

Declaration

public override int GetHashCode()

Returns

Type	Description
int

Overrides

object.GetHashCode()

Parse(string)

Parses the given resource name string into a new PlacementName instance.

Declaration

public static PlacementName Parse(string placementName)

Parameters

Type	Name	Description
string	placementName	The resource name in string form. Must not be null.

Returns

Type	Description
PlacementName	The parsed PlacementName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

• networks/{network_code}/placements/{placement}

Parse(string, bool)

Parses the given resource name string into a new PlacementName instance; optionally allowing an unparseable resource name.

Declaration

public static PlacementName Parse(string placementName, bool allowUnparsed)

Parameters

Type	Name	Description
string	placementName	The resource name in string form. Must not be null.
bool	allowUnparsed	If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.

Returns

Type	Description
PlacementName	The parsed PlacementName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

• networks/{network_code}/placements/{placement}

Or may be in any format if allowUnparsed is true.

ToString()

The string representation of the resource name.

Declaration

public override string ToString()

Returns

Type	Description
string	The string representation of the resource name.

Overrides

object.ToString()

Implements

IResourceName.ToString()

TryParse(string, out PlacementName)

Tries to parse the given resource name string into a new PlacementName instance.

Declaration

public static bool TryParse(string placementName, out PlacementName result)

Parameters

Type	Name	Description
string	placementName	The resource name in string form. Must not be null.
PlacementName	result	When this method returns, the parsed PlacementName, or null if parsing failed.

Returns

Type	Description
bool	true if the name was parsed successfully; false otherwise.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

• networks/{network_code}/placements/{placement}

TryParse(string, bool, out PlacementName)

Tries to parse the given resource name string into a new PlacementName instance; optionally allowing an unparseable resource name.

Declaration

public static bool TryParse(string placementName, bool allowUnparsed, out PlacementName result)

Parameters

Type	Name	Description
string	placementName	The resource name in string form. Must not be null.
bool	allowUnparsed	If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.
PlacementName	result	When this method returns, the parsed PlacementName, or null if parsing failed.

Returns

Type	Description
bool	true if the name was parsed successfully; false otherwise.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

• networks/{network_code}/placements/{placement}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(PlacementName, PlacementName)

Determines whether two specified resource names have the same value.

Declaration

public static bool operator ==(PlacementName a, PlacementName b)

Parameters

Type	Name	Description
PlacementName	a	The first resource name to compare, or null.
PlacementName	b	The second resource name to compare, or null.

Returns

Type	Description
bool	true if the value of a is the same as the value of b; otherwise, false.

operator !=(PlacementName, PlacementName)

Determines whether two specified resource names have different values.

Declaration

public static bool operator !=(PlacementName a, PlacementName b)

Parameters

Type	Name	Description
PlacementName	a	The first resource name to compare, or null.
PlacementName	b	The second resource name to compare, or null.

Returns

Type	Description
bool	true if the value of a is different from the value of b; otherwise, false.