Class RetrieveInsightsRequest (0.8.0)

public final class RetrieveInsightsRequest extends GeneratedMessage implements RetrieveInsightsRequestOrBuilder

Request message for DM API MarketingDataInsightsService.RetrieveInsights

Protobuf type google.ads.datamanager.v1.RetrieveInsightsRequest

Static Fields

BASELINE_FIELD_NUMBER

public static final int BASELINE_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

USER_LIST_ID_FIELD_NUMBER

public static final int USER_LIST_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RetrieveInsightsRequest getDefaultInstance()
Returns
Type Description
RetrieveInsightsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static RetrieveInsightsRequest.Builder newBuilder()
Returns
Type Description
RetrieveInsightsRequest.Builder

newBuilder(RetrieveInsightsRequest prototype)

public static RetrieveInsightsRequest.Builder newBuilder(RetrieveInsightsRequest prototype)
Parameter
Name Description
prototype RetrieveInsightsRequest
Returns
Type Description
RetrieveInsightsRequest.Builder

parseDelimitedFrom(InputStream input)

public static RetrieveInsightsRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RetrieveInsightsRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RetrieveInsightsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RetrieveInsightsRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static RetrieveInsightsRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
RetrieveInsightsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RetrieveInsightsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RetrieveInsightsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RetrieveInsightsRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
RetrieveInsightsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RetrieveInsightsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RetrieveInsightsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RetrieveInsightsRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
RetrieveInsightsRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RetrieveInsightsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RetrieveInsightsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static RetrieveInsightsRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RetrieveInsightsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RetrieveInsightsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RetrieveInsightsRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static RetrieveInsightsRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
RetrieveInsightsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RetrieveInsightsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RetrieveInsightsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<RetrieveInsightsRequest> parser()
Returns
Type Description
Parser<RetrieveInsightsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getBaseline()

public Baseline getBaseline()

Required. Baseline for the insights requested.

.google.ads.datamanager.v1.Baseline baseline = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Baseline

The baseline.

getBaselineOrBuilder()

public BaselineOrBuilder getBaselineOrBuilder()

Required. Baseline for the insights requested.

.google.ads.datamanager.v1.Baseline baseline = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
BaselineOrBuilder

getDefaultInstanceForType()

public RetrieveInsightsRequest getDefaultInstanceForType()
Returns
Type Description
RetrieveInsightsRequest

getParent()

public String getParent()

Required. The parent account that owns the user list. Format: accountTypes/{account_type}/accounts/{account}

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The parent account that owns the user list. Format: accountTypes/{account_type}/accounts/{account}

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

public Parser<RetrieveInsightsRequest> getParserForType()
Returns
Type Description
Parser<RetrieveInsightsRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUserListId()

public String getUserListId()

Required. The user list ID for which insights are requested.

string user_list_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The userListId.

getUserListIdBytes()

public ByteString getUserListIdBytes()

Required. The user list ID for which insights are requested.

string user_list_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for userListId.

hasBaseline()

public boolean hasBaseline()

Required. Baseline for the insights requested.

.google.ads.datamanager.v1.Baseline baseline = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the baseline field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public RetrieveInsightsRequest.Builder newBuilderForType()
Returns
Type Description
RetrieveInsightsRequest.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected RetrieveInsightsRequest.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RetrieveInsightsRequest.Builder
Overrides

toBuilder()

public RetrieveInsightsRequest.Builder toBuilder()
Returns
Type Description
RetrieveInsightsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException