Interface RetrievePartnerMatchReportRequestOrBuilder (0.24.0)

public interface RetrievePartnerMatchReportRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCurrencyCode()

public abstract String getCurrencyCode()

Optional. The currency to return the costs/fees in. If unspecified, defaults to the Data Partner's currency

string currency_code = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The currencyCode.

getCurrencyCodeBytes()

public abstract ByteString getCurrencyCodeBytes()

Optional. The currency to return the costs/fees in. If unspecified, defaults to the Data Partner's currency

string currency_code = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for currencyCode.

getEndDate()

public abstract long getEndDate()

Optional. The end date (inclusive) of the report data to retrieve. Defaults to the current date if not populated. Should be in the format YYYYMMDD.

int64 end_date = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The endDate.

getFilter()

public abstract String getFilter()

Optional. A filter string to apply to the list request. All fields need to be on the left hand side of each condition (for example: user_list_id = 123). Fields must be specified using either all camel case or all snake case. Don't use a combination of camel case and snake case.

Supported Operations:

  • AND
  • =
  • !=
  • >
  • >=
  • <
  • <=

    Supported Functions:

  • IN(field, value1, value2, ...): returns true if the field matches any of the values. Example: IN(user_list_id, 123, 456)

    Supported Fields:

  • advertiser_account.account_type

  • advertiser_account.account_id
  • campaign.campaign_id
  • ad_group.ad_group_id
  • user_list.user_list_id

string filter = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

Optional. A filter string to apply to the list request. All fields need to be on the left hand side of each condition (for example: user_list_id = 123). Fields must be specified using either all camel case or all snake case. Don't use a combination of camel case and snake case.

Supported Operations:

  • AND
  • =
  • !=
  • >
  • >=
  • <
  • <=

    Supported Functions:

  • IN(field, value1, value2, ...): returns true if the field matches any of the values. Example: IN(user_list_id, 123, 456)

    Supported Fields:

  • advertiser_account.account_type

  • advertiser_account.account_id
  • campaign.campaign_id
  • ad_group.ad_group_id
  • user_list.user_list_id

string filter = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for filter.

getPageSize()

public abstract int getPageSize()

Optional. The maximum number of partner match report entries to return per page. The service may return fewer than this value. If unspecified, at most 50 reports will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

int32 page_size = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The pageSize.

getPageToken()

public abstract String getPageToken()

Optional. A page token, received from a previous RetrievePartnerMatchReport call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to RetrievePartnerMatchReport must match the call that provided the page token.

string page_token = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

Optional. A page token, received from a previous RetrievePartnerMatchReport call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to RetrievePartnerMatchReport must match the call that provided the page token.

string page_token = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public abstract 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 abstract 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.

getStartDate()

public abstract long getStartDate()

Required. The start date (inclusive) of the report data to retrieve. Only data from the last 2 years can be retrieved. If the start date is set to an older date, only data from the last 2 years will be returned. Should be in the format YYYYMMDD.

int64 start_date = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
long

The startDate.