Class CreativeWrapperName

Resource name for the CreativeWrapper resource.

Inheritance

object

CreativeWrapperName

Implements

IResourceName

IEquatable<CreativeWrapperName>

Inherited Members

object.GetType()

Namespace: Google.Ads.AdManager.V1

Assembly: Google.Ads.AdManager.V1.dll

Syntax

public sealed class CreativeWrapperName : IResourceName, IEquatable<CreativeWrapperName>

Constructors

CreativeWrapperName(string, string)

Constructs a new instance of a CreativeWrapperName class from the component parts of pattern networks/{network_code}/creativeWrappers/{creative_wrapper}

Declaration

public CreativeWrapperName(string networkCodeId, string creativeWrapperId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	creativeWrapperId	The CreativeWrapper ID. Must not be null or empty.

Properties

CreativeWrapperId

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

Declaration

public string CreativeWrapperId { 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 CreativeWrapperName.ResourceNameType of the contained resource name.

Declaration

public CreativeWrapperName.ResourceNameType Type { get; }

Property Value

Type	Description
CreativeWrapperName.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 CreativeWrapperName with pattern networks/{network_code}/creativeWrappers/{creative_wrapper}.

Declaration

public static string Format(string networkCodeId, string creativeWrapperId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	creativeWrapperId	The CreativeWrapper ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this CreativeWrapperName with pattern networks/{network_code}/creativeWrappers/{creative_wrapper}.

FormatNetworkCodeCreativeWrapper(string, string)

Formats the IDs into the string representation of this CreativeWrapperName with pattern networks/{network_code}/creativeWrappers/{creative_wrapper}.

Declaration

public static string FormatNetworkCodeCreativeWrapper(string networkCodeId, string creativeWrapperId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	creativeWrapperId	The CreativeWrapper ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this CreativeWrapperName with pattern networks/{network_code}/creativeWrappers/{creative_wrapper}.

FromNetworkCodeCreativeWrapper(string, string)

Creates a CreativeWrapperName with the pattern networks/{network_code}/creativeWrappers/{creative_wrapper}.

Declaration

public static CreativeWrapperName FromNetworkCodeCreativeWrapper(string networkCodeId, string creativeWrapperId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	creativeWrapperId	The CreativeWrapper ID. Must not be null or empty.

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a CreativeWrapperName containing an unparsed resource name.

Declaration

public static CreativeWrapperName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

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

Declaration

public static CreativeWrapperName Parse(string creativeWrapperName)

Parameters

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

Returns

Type	Description
CreativeWrapperName	The parsed CreativeWrapperName if successful.

Remarks

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

• networks/{network_code}/creativeWrappers/{creative_wrapper}

Parse(string, bool)

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

Declaration

public static CreativeWrapperName Parse(string creativeWrapperName, bool allowUnparsed)

Parameters

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

Remarks

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

• networks/{network_code}/creativeWrappers/{creative_wrapper}

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

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

Declaration

public static bool TryParse(string creativeWrapperName, out CreativeWrapperName result)

Parameters

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

TryParse(string, bool, out CreativeWrapperName)

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

Declaration

public static bool TryParse(string creativeWrapperName, bool allowUnparsed, out CreativeWrapperName result)

Parameters

Type	Name	Description
string	creativeWrapperName	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.
CreativeWrapperName	result	When this method returns, the parsed CreativeWrapperName, 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}/creativeWrappers/{creative_wrapper}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(CreativeWrapperName, CreativeWrapperName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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