AudienceList

google.analytics.data.v1alpha. AudienceList

Represents an AudienceList.

Constructor

new AudienceList(propertiesopt)

Constructs a new AudienceList.

Parameters:
Name Type Attributes Description
properties google.analytics.data.v1alpha.IAudienceList <optional>

Properties to set

Implements:
  • IAudienceList

Members

_beginCreatingTime

AudienceList _beginCreatingTime.

_errorMessage

AudienceList _errorMessage.

_percentageCompleted

AudienceList _percentageCompleted.

_recurringAudienceList

AudienceList _recurringAudienceList.

_rowCount

AudienceList _rowCount.

_state

AudienceList _state.

audience

AudienceList audience.

audienceDisplayName

AudienceList audienceDisplayName.

beginCreatingTime

AudienceList beginCreatingTime.

creationQuotaTokensCharged

AudienceList creationQuotaTokensCharged.

dimensions

AudienceList dimensions.

errorMessage

AudienceList errorMessage.

name

AudienceList name.

percentageCompleted

AudienceList percentageCompleted.

recurringAudienceList

AudienceList recurringAudienceList.

rowCount

AudienceList rowCount.

state

AudienceList state.

State

State enum.

Properties:
Name Type Description
STATE_UNSPECIFIED number

STATE_UNSPECIFIED value

CREATING number

CREATING value

ACTIVE number

ACTIVE value

FAILED number

FAILED value

Methods

toJSON() → {Object.<string, *>}

Converts this AudienceList to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.analytics.data.v1alpha.AudienceList}

Creates a new AudienceList instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.analytics.data.v1alpha.IAudienceList <optional>

Properties to set

Returns:
Type Description
google.analytics.data.v1alpha.AudienceList

AudienceList instance

(static) decode(reader, lengthopt) → {google.analytics.data.v1alpha.AudienceList}

Decodes an AudienceList message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.analytics.data.v1alpha.AudienceList

AudienceList

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.analytics.data.v1alpha.AudienceList}

Decodes an AudienceList message from the specified reader or buffer, length delimited.

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.analytics.data.v1alpha.AudienceList

AudienceList

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified AudienceList message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.analytics.data.v1alpha.IAudienceList

AudienceList message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

Encodes the specified AudienceList message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.analytics.data.v1alpha.IAudienceList

AudienceList message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.analytics.data.v1alpha.AudienceList}

Creates an AudienceList message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.analytics.data.v1alpha.AudienceList

AudienceList

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for AudienceList

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")

Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from an AudienceList message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.analytics.data.v1alpha.AudienceList

AudienceList

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies an AudienceList message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not