Represents an AudienceList.
Package
@google-analytics/dataConstructors
(constructor)(properties)
constructor(properties?: google.analytics.data.v1alpha.IAudienceList);
Constructs a new AudienceList.
Parameter | |
---|---|
Name | Description |
properties |
IAudienceList
Properties to set |
Properties
_beginCreatingTime
public _beginCreatingTime?: "beginCreatingTime";
AudienceList _beginCreatingTime.
_errorMessage
public _errorMessage?: "errorMessage";
AudienceList _errorMessage.
_percentageCompleted
public _percentageCompleted?: "percentageCompleted";
AudienceList _percentageCompleted.
_recurringAudienceList
public _recurringAudienceList?: "recurringAudienceList";
AudienceList _recurringAudienceList.
_rowCount
public _rowCount?: "rowCount";
AudienceList _rowCount.
_state
public _state?: "state";
AudienceList _state.
_webhookNotification
public _webhookNotification?: "webhookNotification";
AudienceList _webhookNotification.
audience
public audience: string;
AudienceList audience.
audienceDisplayName
public audienceDisplayName: string;
AudienceList audienceDisplayName.
beginCreatingTime
public beginCreatingTime?: (google.protobuf.ITimestamp|null);
AudienceList beginCreatingTime.
creationQuotaTokensCharged
public creationQuotaTokensCharged: number;
AudienceList creationQuotaTokensCharged.
dimensions
public dimensions: google.analytics.data.v1alpha.IAudienceDimension[];
AudienceList dimensions.
errorMessage
public errorMessage?: (string|null);
AudienceList errorMessage.
name
public name: string;
AudienceList name.
percentageCompleted
public percentageCompleted?: (number|null);
AudienceList percentageCompleted.
recurringAudienceList
public recurringAudienceList?: (string|null);
AudienceList recurringAudienceList.
rowCount
public rowCount?: (number|null);
AudienceList rowCount.
state
public state?: (google.analytics.data.v1alpha.AudienceList.State|keyof typeof google.analytics.data.v1alpha.AudienceList.State|null);
AudienceList state.
webhookNotification
public webhookNotification?: (google.analytics.data.v1alpha.IWebhookNotification|null);
AudienceList webhookNotification.
Methods
create(properties)
public static create(properties?: google.analytics.data.v1alpha.IAudienceList): google.analytics.data.v1alpha.AudienceList;
Creates a new AudienceList instance using the specified properties.
Parameter | |
---|---|
Name | Description |
properties |
IAudienceList
Properties to set |
Returns | |
---|---|
Type | Description |
AudienceList |
AudienceList instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.analytics.data.v1alpha.AudienceList;
Decodes an AudienceList message from the specified reader or buffer.
Parameters | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
Returns | |
---|---|
Type | Description |
AudienceList |
AudienceList |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.analytics.data.v1alpha.AudienceList;
Decodes an AudienceList message from the specified reader or buffer, length delimited.
Parameter | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
Returns | |
---|---|
Type | Description |
AudienceList |
AudienceList |
encode(message, writer)
public static encode(message: google.analytics.data.v1alpha.IAudienceList, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified AudienceList message. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IAudienceList
AudienceList message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Returns | |
---|---|
Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.analytics.data.v1alpha.IAudienceList, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified AudienceList message, length delimited. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IAudienceList
AudienceList message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Returns | |
---|---|
Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.analytics.data.v1alpha.AudienceList;
Creates an AudienceList message from a plain object. Also converts values to their respective internal types.
Parameter | |
---|---|
Name | Description |
object |
{ [k: string]: any }
Plain object |
Returns | |
---|---|
Type | Description |
AudienceList |
AudienceList |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for AudienceList
Parameter | |
---|---|
Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns | |
---|---|
Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };
Converts this AudienceList to JSON.
Returns | |
---|---|
Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.analytics.data.v1alpha.AudienceList, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from an AudienceList message. Also converts values to other types if specified.
Parameters | |
---|---|
Name | Description |
message |
AudienceList
AudienceList |
options |
$protobuf.IConversionOptions
Conversion options |
Returns | |
---|---|
Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);
Verifies an AudienceList message.
Parameter | |
---|---|
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Returns | |
---|---|
Type | Description |
(string|null) |
|