Class AdSpotName

Resource name for the AdSpot resource.

Inheritance

object

AdSpotName

Implements

IResourceName

IEquatable<AdSpotName>

Inherited Members

object.GetType()

Namespace: Google.Ads.AdManager.V1

Assembly: Google.Ads.AdManager.V1.dll

Syntax

public sealed class AdSpotName : IResourceName, IEquatable<AdSpotName>

Constructors

AdSpotName(string, string)

Constructs a new instance of a AdSpotName class from the component parts of pattern networks/{network_code}/adSpots/{ad_spot}

Declaration

public AdSpotName(string networkCodeId, string adSpotId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	adSpotId	The AdSpot ID. Must not be null or empty.

Properties

AdSpotId

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

Declaration

public string AdSpotId { get; }

Property Value

Type	Description
string

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

Type

The AdSpotName.ResourceNameType of the contained resource name.

Declaration

public AdSpotName.ResourceNameType Type { get; }

Property Value

Type	Description
AdSpotName.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 AdSpotName with pattern networks/{network_code}/adSpots/{ad_spot}.

Declaration

public static string Format(string networkCodeId, string adSpotId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	adSpotId	The AdSpot ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this AdSpotName with pattern networks/{network_code}/adSpots/{ad_spot}.

FormatNetworkCodeAdSpot(string, string)

Formats the IDs into the string representation of this AdSpotName with pattern networks/{network_code}/adSpots/{ad_spot}.

Declaration

public static string FormatNetworkCodeAdSpot(string networkCodeId, string adSpotId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	adSpotId	The AdSpot ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this AdSpotName with pattern networks/{network_code}/adSpots/{ad_spot}.

FromNetworkCodeAdSpot(string, string)

Creates a AdSpotName with the pattern networks/{network_code}/adSpots/{ad_spot}.

Declaration

public static AdSpotName FromNetworkCodeAdSpot(string networkCodeId, string adSpotId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	adSpotId	The AdSpot ID. Must not be null or empty.

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a AdSpotName containing an unparsed resource name.

Declaration

public static AdSpotName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

Type	Description
AdSpotName	A new instance of AdSpotName 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 AdSpotName instance.

Declaration

public static AdSpotName Parse(string adSpotName)

Parameters

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

Returns

Type	Description
AdSpotName	The parsed AdSpotName if successful.

Remarks

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

• networks/{network_code}/adSpots/{ad_spot}

Parse(string, bool)

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

Declaration

public static AdSpotName Parse(string adSpotName, bool allowUnparsed)

Parameters

Type	Name	Description
string	adSpotName	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
AdSpotName	The parsed AdSpotName if successful.

Remarks

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

• networks/{network_code}/adSpots/{ad_spot}

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 AdSpotName)

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

Declaration

public static bool TryParse(string adSpotName, out AdSpotName result)

Parameters

Type	Name	Description
string	adSpotName	The resource name in string form. Must not be null.
AdSpotName	result	When this method returns, the parsed AdSpotName, 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}/adSpots/{ad_spot}

TryParse(string, bool, out AdSpotName)

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

Declaration

public static bool TryParse(string adSpotName, bool allowUnparsed, out AdSpotName result)

Parameters

Type	Name	Description
string	adSpotName	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.
AdSpotName	result	When this method returns, the parsed AdSpotName, 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}/adSpots/{ad_spot}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(AdSpotName, AdSpotName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

Type	Name	Description
AdSpotName	a	The first resource name to compare, or null.
AdSpotName	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 !=(AdSpotName, AdSpotName)

Determines whether two specified resource names have different values.

Declaration

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

Parameters

Type	Name	Description
AdSpotName	a	The first resource name to compare, or null.
AdSpotName	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.