Class protos.google.analytics.admin.v1alpha.DataSharingSettings (4.5.1)

Represents a DataSharingSettings.

Package

@google-analytics/admin

Constructors

(constructor)(properties)

constructor(properties?: google.analytics.admin.v1alpha.IDataSharingSettings);

Constructs a new DataSharingSettings.

Parameter
NameDescription
properties IDataSharingSettings

Properties to set

Properties

name

public name: string;

DataSharingSettings name.

sharingWithGoogleAnySalesEnabled

public sharingWithGoogleAnySalesEnabled: boolean;

DataSharingSettings sharingWithGoogleAnySalesEnabled.

sharingWithGoogleAssignedSalesEnabled

public sharingWithGoogleAssignedSalesEnabled: boolean;

DataSharingSettings sharingWithGoogleAssignedSalesEnabled.

sharingWithGoogleProductsEnabled

public sharingWithGoogleProductsEnabled: boolean;

DataSharingSettings sharingWithGoogleProductsEnabled.

sharingWithGoogleSupportEnabled

public sharingWithGoogleSupportEnabled: boolean;

DataSharingSettings sharingWithGoogleSupportEnabled.

sharingWithOthersEnabled

public sharingWithOthersEnabled: boolean;

DataSharingSettings sharingWithOthersEnabled.

Methods

create(properties)

public static create(properties?: google.analytics.admin.v1alpha.IDataSharingSettings): google.analytics.admin.v1alpha.DataSharingSettings;

Creates a new DataSharingSettings instance using the specified properties.

Parameter
NameDescription
properties IDataSharingSettings

Properties to set

Returns
TypeDescription
google.analytics.admin.v1alpha.DataSharingSettings

DataSharingSettings instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.analytics.admin.v1alpha.DataSharingSettings;

Decodes a DataSharingSettings message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.analytics.admin.v1alpha.DataSharingSettings

DataSharingSettings

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.analytics.admin.v1alpha.DataSharingSettings;

Decodes a DataSharingSettings message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.analytics.admin.v1alpha.DataSharingSettings

DataSharingSettings

encode(message, writer)

public static encode(message: google.analytics.admin.v1alpha.IDataSharingSettings, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified DataSharingSettings message. Does not implicitly messages.

Parameters
NameDescription
message IDataSharingSettings

DataSharingSettings message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.analytics.admin.v1alpha.IDataSharingSettings, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IDataSharingSettings

DataSharingSettings message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.analytics.admin.v1alpha.DataSharingSettings;

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

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.analytics.admin.v1alpha.DataSharingSettings

DataSharingSettings

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for DataSharingSettings

Parameter
NameDescription
typeUrlPrefix string

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

Returns
TypeDescription
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this DataSharingSettings to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.analytics.admin.v1alpha.DataSharingSettings, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
NameDescription
message google.analytics.admin.v1alpha.DataSharingSettings

DataSharingSettings

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a DataSharingSettings message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not