Constructor
new AudienceExport(propertiesopt)
Constructs a new AudienceExport.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.analytics.data.v1beta.IAudienceExport |
<optional> |
Properties to set |
- Implements:
-
- IAudienceExport
Members
_beginCreatingTime
AudienceExport _beginCreatingTime.
_errorMessage
AudienceExport _errorMessage.
_percentageCompleted
AudienceExport _percentageCompleted.
_rowCount
AudienceExport _rowCount.
_state
AudienceExport _state.
audience
AudienceExport audience.
audienceDisplayName
AudienceExport audienceDisplayName.
beginCreatingTime
AudienceExport beginCreatingTime.
creationQuotaTokensCharged
AudienceExport creationQuotaTokensCharged.
dimensions
AudienceExport dimensions.
errorMessage
AudienceExport errorMessage.
name
AudienceExport name.
percentageCompleted
AudienceExport percentageCompleted.
rowCount
AudienceExport rowCount.
state
AudienceExport 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 AudienceExport to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.analytics.data.v1beta.AudienceExport}
Creates a new AudienceExport instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.analytics.data.v1beta.IAudienceExport |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.analytics.data.v1beta.AudienceExport |
AudienceExport instance |
(static) decode(reader, lengthopt) → {google.analytics.data.v1beta.AudienceExport}
Decodes an AudienceExport 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.v1beta.AudienceExport |
AudienceExport |
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.v1beta.AudienceExport}
Decodes an AudienceExport 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.v1beta.AudienceExport |
AudienceExport |
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 AudienceExport message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.analytics.data.v1beta.IAudienceExport |
AudienceExport 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 AudienceExport message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.analytics.data.v1beta.IAudienceExport |
AudienceExport 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.v1beta.AudienceExport}
Creates an AudienceExport 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.v1beta.AudienceExport |
AudienceExport |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for AudienceExport
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 AudienceExport message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.analytics.data.v1beta.AudienceExport |
AudienceExport |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies an AudienceExport message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|