admob

package
v0.0.0-...-0b04860 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 4, 2020 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	SortOrder_name = map[int32]string{
		0: "SORT_ORDER_UNSPECIFIED",
		1: "ASCENDING",
		2: "DESCENDING",
	}
	SortOrder_value = map[string]int32{
		"SORT_ORDER_UNSPECIFIED": 0,
		"ASCENDING":              1,
		"DESCENDING":             2,
	}
)

Enum value maps for SortOrder.

View Source
var (
	NetworkReportSpec_Dimension_name = map[int32]string{
		0: "DIMENSION_UNSPECIFIED",
		1: "DATE",
		2: "MONTH",
		3: "WEEK",
		4: "AD_UNIT",
		5: "APP",
		6: "AD_TYPE",
		7: "COUNTRY",
		8: "FORMAT",
		9: "PLATFORM",
	}
	NetworkReportSpec_Dimension_value = map[string]int32{
		"DIMENSION_UNSPECIFIED": 0,
		"DATE":                  1,
		"MONTH":                 2,
		"WEEK":                  3,
		"AD_UNIT":               4,
		"APP":                   5,
		"AD_TYPE":               6,
		"COUNTRY":               7,
		"FORMAT":                8,
		"PLATFORM":              9,
	}
)

Enum value maps for NetworkReportSpec_Dimension.

View Source
var (
	NetworkReportSpec_Metric_name = map[int32]string{
		0: "METRIC_UNSPECIFIED",
		1: "AD_REQUESTS",
		2: "CLICKS",
		3: "ESTIMATED_EARNINGS",
		4: "IMPRESSIONS",
		5: "IMPRESSION_CTR",
		6: "IMPRESSION_RPM",
		7: "MATCHED_REQUESTS",
		8: "MATCH_RATE",
		9: "SHOW_RATE",
	}
	NetworkReportSpec_Metric_value = map[string]int32{
		"METRIC_UNSPECIFIED": 0,
		"AD_REQUESTS":        1,
		"CLICKS":             2,
		"ESTIMATED_EARNINGS": 3,
		"IMPRESSIONS":        4,
		"IMPRESSION_CTR":     5,
		"IMPRESSION_RPM":     6,
		"MATCHED_REQUESTS":   7,
		"MATCH_RATE":         8,
		"SHOW_RATE":          9,
	}
)

Enum value maps for NetworkReportSpec_Metric.

View Source
var (
	MediationReportSpec_Dimension_name = map[int32]string{
		0:  "DIMENSION_UNSPECIFIED",
		1:  "DATE",
		2:  "MONTH",
		3:  "WEEK",
		4:  "AD_SOURCE",
		5:  "AD_SOURCE_INSTANCE",
		6:  "AD_UNIT",
		7:  "APP",
		11: "MEDIATION_GROUP",
		8:  "COUNTRY",
		9:  "FORMAT",
		10: "PLATFORM",
	}
	MediationReportSpec_Dimension_value = map[string]int32{
		"DIMENSION_UNSPECIFIED": 0,
		"DATE":                  1,
		"MONTH":                 2,
		"WEEK":                  3,
		"AD_SOURCE":             4,
		"AD_SOURCE_INSTANCE":    5,
		"AD_UNIT":               6,
		"APP":                   7,
		"MEDIATION_GROUP":       11,
		"COUNTRY":               8,
		"FORMAT":                9,
		"PLATFORM":              10,
	}
)

Enum value maps for MediationReportSpec_Dimension.

View Source
var (
	MediationReportSpec_Metric_name = map[int32]string{
		0: "METRIC_UNSPECIFIED",
		1: "AD_REQUESTS",
		2: "CLICKS",
		3: "ESTIMATED_EARNINGS",
		4: "IMPRESSIONS",
		5: "IMPRESSION_CTR",
		6: "MATCHED_REQUESTS",
		7: "MATCH_RATE",
		8: "OBSERVED_ECPM",
	}
	MediationReportSpec_Metric_value = map[string]int32{
		"METRIC_UNSPECIFIED": 0,
		"AD_REQUESTS":        1,
		"CLICKS":             2,
		"ESTIMATED_EARNINGS": 3,
		"IMPRESSIONS":        4,
		"IMPRESSION_CTR":     5,
		"MATCHED_REQUESTS":   6,
		"MATCH_RATE":         7,
		"OBSERVED_ECPM":      8,
	}
)

Enum value maps for MediationReportSpec_Metric.

View Source
var (
	ReportWarning_Type_name = map[int32]string{
		0: "TYPE_UNSPECIFIED",
		1: "DATA_BEFORE_ACCOUNT_TIMEZONE_CHANGE",
		2: "DATA_DELAYED",
		3: "OTHER",
		4: "REPORT_CURRENCY_NOT_ACCOUNT_CURRENCY",
	}
	ReportWarning_Type_value = map[string]int32{
		"TYPE_UNSPECIFIED":                     0,
		"DATA_BEFORE_ACCOUNT_TIMEZONE_CHANGE":  1,
		"DATA_DELAYED":                         2,
		"OTHER":                                3,
		"REPORT_CURRENCY_NOT_ACCOUNT_CURRENCY": 4,
	}
)

Enum value maps for ReportWarning_Type.

View Source
var File_google_ads_admob_v1_admob_api_proto protoreflect.FileDescriptor
View Source
var File_google_ads_admob_v1_admob_resources_proto protoreflect.FileDescriptor

Functions

func RegisterAdMobApiServer

func RegisterAdMobApiServer(s *grpc.Server, srv AdMobApiServer)

Types

type AdMobApiClient

type AdMobApiClient interface {
	// Gets information about the specified AdMob publisher account.
	GetPublisherAccount(ctx context.Context, in *GetPublisherAccountRequest, opts ...grpc.CallOption) (*PublisherAccount, error)
	// Lists the AdMob publisher account accessible with the client credential.
	// Currently, all credentials have access to at most one AdMob account.
	ListPublisherAccounts(ctx context.Context, in *ListPublisherAccountsRequest, opts ...grpc.CallOption) (*ListPublisherAccountsResponse, error)
	// Generates an AdMob Network report based on the provided report
	// specification.
	GenerateNetworkReport(ctx context.Context, in *GenerateNetworkReportRequest, opts ...grpc.CallOption) (AdMobApi_GenerateNetworkReportClient, error)
	// Generates an AdMob Mediation report based on the provided report
	// specification.
	GenerateMediationReport(ctx context.Context, in *GenerateMediationReportRequest, opts ...grpc.CallOption) (AdMobApi_GenerateMediationReportClient, error)
}

AdMobApiClient is the client API for AdMobApi service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewAdMobApiClient

func NewAdMobApiClient(cc grpc.ClientConnInterface) AdMobApiClient

type AdMobApiServer

type AdMobApiServer interface {
	// Gets information about the specified AdMob publisher account.
	GetPublisherAccount(context.Context, *GetPublisherAccountRequest) (*PublisherAccount, error)
	// Lists the AdMob publisher account accessible with the client credential.
	// Currently, all credentials have access to at most one AdMob account.
	ListPublisherAccounts(context.Context, *ListPublisherAccountsRequest) (*ListPublisherAccountsResponse, error)
	// Generates an AdMob Network report based on the provided report
	// specification.
	GenerateNetworkReport(*GenerateNetworkReportRequest, AdMobApi_GenerateNetworkReportServer) error
	// Generates an AdMob Mediation report based on the provided report
	// specification.
	GenerateMediationReport(*GenerateMediationReportRequest, AdMobApi_GenerateMediationReportServer) error
}

AdMobApiServer is the server API for AdMobApi service.

type AdMobApi_GenerateMediationReportClient

type AdMobApi_GenerateMediationReportClient interface {
	Recv() (*GenerateMediationReportResponse, error)
	grpc.ClientStream
}

type AdMobApi_GenerateMediationReportServer

type AdMobApi_GenerateMediationReportServer interface {
	Send(*GenerateMediationReportResponse) error
	grpc.ServerStream
}

type AdMobApi_GenerateNetworkReportClient

type AdMobApi_GenerateNetworkReportClient interface {
	Recv() (*GenerateNetworkReportResponse, error)
	grpc.ClientStream
}

type AdMobApi_GenerateNetworkReportServer

type AdMobApi_GenerateNetworkReportServer interface {
	Send(*GenerateNetworkReportResponse) error
	grpc.ServerStream
}

type DateRange

type DateRange struct {

	// Start date of the date range, inclusive. Must be less than or equal to the
	// end date.
	StartDate *date.Date `protobuf:"bytes,1,opt,name=start_date,json=startDate,proto3" json:"start_date,omitempty"`
	// End date of the date range, inclusive. Must be greater than or equal to the
	// start date.
	EndDate *date.Date `protobuf:"bytes,2,opt,name=end_date,json=endDate,proto3" json:"end_date,omitempty"`
	// contains filtered or unexported fields
}

Specification of a single date range. Both dates are inclusive.

func (*DateRange) Descriptor deprecated

func (*DateRange) Descriptor() ([]byte, []int)

Deprecated: Use DateRange.ProtoReflect.Descriptor instead.

func (*DateRange) GetEndDate

func (x *DateRange) GetEndDate() *date.Date

func (*DateRange) GetStartDate

func (x *DateRange) GetStartDate() *date.Date

func (*DateRange) ProtoMessage

func (*DateRange) ProtoMessage()

func (*DateRange) ProtoReflect

func (x *DateRange) ProtoReflect() protoreflect.Message

func (*DateRange) Reset

func (x *DateRange) Reset()

func (*DateRange) String

func (x *DateRange) String() string

type GenerateMediationReportRequest

type GenerateMediationReportRequest struct {

	// Resource name of the account to generate the report for.
	// Example: accounts/pub-9876543210987654
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Network report specification.
	ReportSpec *MediationReportSpec `protobuf:"bytes,2,opt,name=report_spec,json=reportSpec,proto3" json:"report_spec,omitempty"`
	// contains filtered or unexported fields
}

Request to generate an AdMob Mediation report.

func (*GenerateMediationReportRequest) Descriptor deprecated

func (*GenerateMediationReportRequest) Descriptor() ([]byte, []int)

Deprecated: Use GenerateMediationReportRequest.ProtoReflect.Descriptor instead.

func (*GenerateMediationReportRequest) GetParent

func (x *GenerateMediationReportRequest) GetParent() string

func (*GenerateMediationReportRequest) GetReportSpec

func (*GenerateMediationReportRequest) ProtoMessage

func (*GenerateMediationReportRequest) ProtoMessage()

func (*GenerateMediationReportRequest) ProtoReflect

func (*GenerateMediationReportRequest) Reset

func (x *GenerateMediationReportRequest) Reset()

func (*GenerateMediationReportRequest) String

type GenerateMediationReportResponse

type GenerateMediationReportResponse struct {

	// Each stream response message contains one type of payload.
	//
	// Types that are assignable to Payload:
	//	*GenerateMediationReportResponse_Header
	//	*GenerateMediationReportResponse_Row
	//	*GenerateMediationReportResponse_Footer
	Payload isGenerateMediationReportResponse_Payload `protobuf_oneof:"payload"`
	// contains filtered or unexported fields
}

The streaming response for the AdMob Mediation report where the first response contains the report header, then a stream of row responses, and finally a footer as the last response message.

For example:

[{
  "header": {
    "date_range": {
      "start_date": {"year": 2018, "month": 9, "day": 1},
      "end_date": {"year": 2018, "month": 9, "day": 1}
    },
    "localization_settings": {
      "currency_code": "USD",
      "language_code": "en-US"
    }
  }
},
{
  "row": {
    "dimension_values": {
      "DATE": {"value": "20180918"},
      "APP": {
        "value": "ca-app-pub-8123415297019784~1001342552",
         "display_label": "My app name!"
      }
    },
    "metric_values": {
      "ESTIMATED_EARNINGS": {"decimal_value": "1324746"}
    }
  }
},
{
  "footer": {"matching_row_count": 1}
}]

func (*GenerateMediationReportResponse) Descriptor deprecated

func (*GenerateMediationReportResponse) Descriptor() ([]byte, []int)

Deprecated: Use GenerateMediationReportResponse.ProtoReflect.Descriptor instead.

func (*GenerateMediationReportResponse) GetFooter

func (*GenerateMediationReportResponse) GetHeader

func (*GenerateMediationReportResponse) GetPayload

func (m *GenerateMediationReportResponse) GetPayload() isGenerateMediationReportResponse_Payload

func (*GenerateMediationReportResponse) GetRow

func (*GenerateMediationReportResponse) ProtoMessage

func (*GenerateMediationReportResponse) ProtoMessage()

func (*GenerateMediationReportResponse) ProtoReflect

func (*GenerateMediationReportResponse) Reset

func (*GenerateMediationReportResponse) String

type GenerateMediationReportResponse_Footer struct {
	// Additional information about the generated report, such as warnings about
	// the data.
	Footer *ReportFooter `protobuf:"bytes,3,opt,name=footer,proto3,oneof"`
}

type GenerateMediationReportResponse_Header

type GenerateMediationReportResponse_Header struct {
	// Report generation settings that describes the report contents, such as
	// the report date range and localization settings.
	Header *ReportHeader `protobuf:"bytes,1,opt,name=header,proto3,oneof"`
}

type GenerateMediationReportResponse_Row

type GenerateMediationReportResponse_Row struct {
	// Actual report data.
	Row *ReportRow `protobuf:"bytes,2,opt,name=row,proto3,oneof"`
}

type GenerateNetworkReportRequest

type GenerateNetworkReportRequest struct {

	// Resource name of the account to generate the report for.
	// Example: accounts/pub-9876543210987654
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Network report specification.
	ReportSpec *NetworkReportSpec `protobuf:"bytes,2,opt,name=report_spec,json=reportSpec,proto3" json:"report_spec,omitempty"`
	// contains filtered or unexported fields
}

Request to generate an AdMob Network report.

func (*GenerateNetworkReportRequest) Descriptor deprecated

func (*GenerateNetworkReportRequest) Descriptor() ([]byte, []int)

Deprecated: Use GenerateNetworkReportRequest.ProtoReflect.Descriptor instead.

func (*GenerateNetworkReportRequest) GetParent

func (x *GenerateNetworkReportRequest) GetParent() string

func (*GenerateNetworkReportRequest) GetReportSpec

func (x *GenerateNetworkReportRequest) GetReportSpec() *NetworkReportSpec

func (*GenerateNetworkReportRequest) ProtoMessage

func (*GenerateNetworkReportRequest) ProtoMessage()

func (*GenerateNetworkReportRequest) ProtoReflect

func (*GenerateNetworkReportRequest) Reset

func (x *GenerateNetworkReportRequest) Reset()

func (*GenerateNetworkReportRequest) String

type GenerateNetworkReportResponse

type GenerateNetworkReportResponse struct {

	// Each stream response message contains one type of payload.
	//
	// Types that are assignable to Payload:
	//	*GenerateNetworkReportResponse_Header
	//	*GenerateNetworkReportResponse_Row
	//	*GenerateNetworkReportResponse_Footer
	Payload isGenerateNetworkReportResponse_Payload `protobuf_oneof:"payload"`
	// contains filtered or unexported fields
}

The streaming response for the AdMob Network report where the first response contains the report header, then a stream of row responses, and finally a footer as the last response message.

For example:

[{
  "header": {
    "dateRange": {
      "startDate": {"year": 2018, "month": 9, "day": 1},
      "endDate": {"year": 2018, "month": 9, "day": 1}
    },
    "localizationSettings": {
      "currencyCode": "USD",
      "languageCode": "en-US"
    }
  }
},
{
  "row": {
    "dimensionValues": {
      "DATE": {"value": "20180918"},
      "APP": {
        "value": "ca-app-pub-8123415297019784~1001342552",
         displayLabel: "My app name!"
      }
    },
    "metricValues": {
      "ESTIMATED_EARNINGS": {"microsValue": 6500000}
    }
  }
},
{
  "footer": {"matchingRowCount": 1}
}]

func (*GenerateNetworkReportResponse) Descriptor deprecated

func (*GenerateNetworkReportResponse) Descriptor() ([]byte, []int)

Deprecated: Use GenerateNetworkReportResponse.ProtoReflect.Descriptor instead.

func (*GenerateNetworkReportResponse) GetFooter

func (*GenerateNetworkReportResponse) GetHeader

func (*GenerateNetworkReportResponse) GetPayload

func (m *GenerateNetworkReportResponse) GetPayload() isGenerateNetworkReportResponse_Payload

func (*GenerateNetworkReportResponse) GetRow

func (*GenerateNetworkReportResponse) ProtoMessage

func (*GenerateNetworkReportResponse) ProtoMessage()

func (*GenerateNetworkReportResponse) ProtoReflect

func (*GenerateNetworkReportResponse) Reset

func (x *GenerateNetworkReportResponse) Reset()

func (*GenerateNetworkReportResponse) String

type GenerateNetworkReportResponse_Footer struct {
	// Additional information about the generated report, such as warnings about
	// the data.
	Footer *ReportFooter `protobuf:"bytes,3,opt,name=footer,proto3,oneof"`
}

type GenerateNetworkReportResponse_Header

type GenerateNetworkReportResponse_Header struct {
	// Report generation settings that describes the report contents, such as
	// the report date range and localization settings.
	Header *ReportHeader `protobuf:"bytes,1,opt,name=header,proto3,oneof"`
}

type GenerateNetworkReportResponse_Row

type GenerateNetworkReportResponse_Row struct {
	// Actual report data.
	Row *ReportRow `protobuf:"bytes,2,opt,name=row,proto3,oneof"`
}

type GetPublisherAccountRequest

type GetPublisherAccountRequest struct {

	// Resource name of the publisher account to retrieve.
	// Example: accounts/pub-9876543210987654
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request to retrieve the specified publisher account.

func (*GetPublisherAccountRequest) Descriptor deprecated

func (*GetPublisherAccountRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetPublisherAccountRequest.ProtoReflect.Descriptor instead.

func (*GetPublisherAccountRequest) GetName

func (x *GetPublisherAccountRequest) GetName() string

func (*GetPublisherAccountRequest) ProtoMessage

func (*GetPublisherAccountRequest) ProtoMessage()

func (*GetPublisherAccountRequest) ProtoReflect

func (*GetPublisherAccountRequest) Reset

func (x *GetPublisherAccountRequest) Reset()

func (*GetPublisherAccountRequest) String

func (x *GetPublisherAccountRequest) String() string

type ListPublisherAccountsRequest

type ListPublisherAccountsRequest struct {

	// Maximum number of accounts to return.
	PageSize int32 `protobuf:"varint,1,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// The value returned by the last `ListPublisherAccountsResponse`; indicates
	// that this is a continuation of a prior `ListPublisherAccounts` call, and
	// that the system should return the next page of data.
	PageToken string `protobuf:"bytes,2,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request to retrieve the AdMob publisher account accessible with the client credential. Currently all credentials have access to at most 1 account.

func (*ListPublisherAccountsRequest) Descriptor deprecated

func (*ListPublisherAccountsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListPublisherAccountsRequest.ProtoReflect.Descriptor instead.

func (*ListPublisherAccountsRequest) GetPageSize

func (x *ListPublisherAccountsRequest) GetPageSize() int32

func (*ListPublisherAccountsRequest) GetPageToken

func (x *ListPublisherAccountsRequest) GetPageToken() string

func (*ListPublisherAccountsRequest) ProtoMessage

func (*ListPublisherAccountsRequest) ProtoMessage()

func (*ListPublisherAccountsRequest) ProtoReflect

func (*ListPublisherAccountsRequest) Reset

func (x *ListPublisherAccountsRequest) Reset()

func (*ListPublisherAccountsRequest) String

type ListPublisherAccountsResponse

type ListPublisherAccountsResponse struct {

	// Publisher that the client credentials can access.
	Account []*PublisherAccount `protobuf:"bytes,1,rep,name=account,proto3" json:"account,omitempty"`
	// If not empty, indicates that there might be more accounts for the request;
	// you must pass this value in a new `ListPublisherAccountsRequest`.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response for the publisher account list request.

func (*ListPublisherAccountsResponse) Descriptor deprecated

func (*ListPublisherAccountsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListPublisherAccountsResponse.ProtoReflect.Descriptor instead.

func (*ListPublisherAccountsResponse) GetAccount

func (*ListPublisherAccountsResponse) GetNextPageToken

func (x *ListPublisherAccountsResponse) GetNextPageToken() string

func (*ListPublisherAccountsResponse) ProtoMessage

func (*ListPublisherAccountsResponse) ProtoMessage()

func (*ListPublisherAccountsResponse) ProtoReflect

func (*ListPublisherAccountsResponse) Reset

func (x *ListPublisherAccountsResponse) Reset()

func (*ListPublisherAccountsResponse) String

type LocalizationSettings

type LocalizationSettings struct {

	// Currency code of the earning related metrics, which is the 3-letter code
	// defined in ISO 4217. The daily average rate is used for the currency
	// conversion. Defaults to the account currency code if unspecified.
	CurrencyCode string `protobuf:"bytes,1,opt,name=currency_code,json=currencyCode,proto3" json:"currency_code,omitempty"`
	// Language used for any localized text, such as some dimension value display
	// labels. The language tag defined in the IETF BCP47. Defaults to 'en-US' if
	// unspecified.
	LanguageCode string `protobuf:"bytes,2,opt,name=language_code,json=languageCode,proto3" json:"language_code,omitempty"`
	// contains filtered or unexported fields
}

Localization settings for reports, such as currency and language. It affects how metrics are calculated.

func (*LocalizationSettings) Descriptor deprecated

func (*LocalizationSettings) Descriptor() ([]byte, []int)

Deprecated: Use LocalizationSettings.ProtoReflect.Descriptor instead.

func (*LocalizationSettings) GetCurrencyCode

func (x *LocalizationSettings) GetCurrencyCode() string

func (*LocalizationSettings) GetLanguageCode

func (x *LocalizationSettings) GetLanguageCode() string

func (*LocalizationSettings) ProtoMessage

func (*LocalizationSettings) ProtoMessage()

func (*LocalizationSettings) ProtoReflect

func (x *LocalizationSettings) ProtoReflect() protoreflect.Message

func (*LocalizationSettings) Reset

func (x *LocalizationSettings) Reset()

func (*LocalizationSettings) String

func (x *LocalizationSettings) String() string

type MediationReportSpec

type MediationReportSpec struct {

	// The date range for which the report is generated.
	DateRange *DateRange `protobuf:"bytes,1,opt,name=date_range,json=dateRange,proto3" json:"date_range,omitempty"`
	// List of dimensions of the report. The value combination of these dimensions
	// determines the row of the report. If no dimensions are specified, the
	// report returns a single row of requested metrics for the entire account.
	Dimensions []MediationReportSpec_Dimension `` /* 136-byte string literal not displayed */
	// List of metrics of the report. A report must specify at least one metric.
	Metrics []MediationReportSpec_Metric `` /* 127-byte string literal not displayed */
	// Describes which report rows to match based on their dimension values.
	DimensionFilters []*MediationReportSpec_DimensionFilter `protobuf:"bytes,4,rep,name=dimension_filters,json=dimensionFilters,proto3" json:"dimension_filters,omitempty"`
	// Describes the sorting of report rows. The order of the condition in the
	// list defines its precedence; the earlier the condition, the higher its
	// precedence. If no sort conditions are specified, the row ordering is
	// undefined.
	SortConditions []*MediationReportSpec_SortCondition `protobuf:"bytes,5,rep,name=sort_conditions,json=sortConditions,proto3" json:"sort_conditions,omitempty"`
	// Localization settings of the report.
	LocalizationSettings *LocalizationSettings `protobuf:"bytes,6,opt,name=localization_settings,json=localizationSettings,proto3" json:"localization_settings,omitempty"`
	// Maximum number of report data rows to return. If the value is not set, the
	// API returns as many rows as possible, up to 100000. Acceptable values are
	// 1-100000, inclusive. Any other values are treated as 100000.
	MaxReportRows int32 `protobuf:"varint,7,opt,name=max_report_rows,json=maxReportRows,proto3" json:"max_report_rows,omitempty"`
	// A report time zone. Accepts an IANA TZ name values, such as
	// "America/Los_Angeles."  If no time zone is defined, the account default
	// takes effect. Check default value by the get account action.
	//
	// **Warning:** The "America/Los_Angeles" is the only supported value at
	// the moment.
	TimeZone string `protobuf:"bytes,8,opt,name=time_zone,json=timeZone,proto3" json:"time_zone,omitempty"`
	// contains filtered or unexported fields
}

The specification for generating an AdMob Mediation report. For example, the specification to get observed ECPM sliced by ad source and app for the 'US' and 'CN' countries can look like the following example:

{
  "date_range": {
    "start_date": {"year": 2018, "month": 9, "day": 1},
    "end_date": {"year": 2018, "month": 9, "day": 30}
  },
  "dimensions": ["AD_SOURCE", "APP", "COUNTRY"],
  "metrics": ["OBSERVED_ECPM"],
  "dimension_filters": [
    {
      "dimension": "COUNTRY",
      "matches_any": {"values": [{"value": "US", "value": "CN"}]}
    }
  ],
  "sort_conditions": [
    {"dimension":"APP", order: "ASCENDING"}
  ],
  "localization_settings": {
    "currency_code": "USD",
    "language_code": "en-US"
  }
}

For a better understanding, you can treat the preceding specification like the following pseudo SQL:

SELECT AD_SOURCE, APP, COUNTRY, OBSERVED_ECPM
FROM MEDIATION_REPORT
WHERE DATE >= '2018-09-01' AND DATE <= '2018-09-30'
    AND COUNTRY IN ('US', 'CN')
GROUP BY AD_SOURCE, APP, COUNTRY
ORDER BY APP ASC;

func (*MediationReportSpec) Descriptor deprecated

func (*MediationReportSpec) Descriptor() ([]byte, []int)

Deprecated: Use MediationReportSpec.ProtoReflect.Descriptor instead.

func (*MediationReportSpec) GetDateRange

func (x *MediationReportSpec) GetDateRange() *DateRange

func (*MediationReportSpec) GetDimensionFilters

func (x *MediationReportSpec) GetDimensionFilters() []*MediationReportSpec_DimensionFilter

func (*MediationReportSpec) GetDimensions

func (*MediationReportSpec) GetLocalizationSettings

func (x *MediationReportSpec) GetLocalizationSettings() *LocalizationSettings

func (*MediationReportSpec) GetMaxReportRows

func (x *MediationReportSpec) GetMaxReportRows() int32

func (*MediationReportSpec) GetMetrics

func (*MediationReportSpec) GetSortConditions

func (x *MediationReportSpec) GetSortConditions() []*MediationReportSpec_SortCondition

func (*MediationReportSpec) GetTimeZone

func (x *MediationReportSpec) GetTimeZone() string

func (*MediationReportSpec) ProtoMessage

func (*MediationReportSpec) ProtoMessage()

func (*MediationReportSpec) ProtoReflect

func (x *MediationReportSpec) ProtoReflect() protoreflect.Message

func (*MediationReportSpec) Reset

func (x *MediationReportSpec) Reset()

func (*MediationReportSpec) String

func (x *MediationReportSpec) String() string

type MediationReportSpec_Dimension

type MediationReportSpec_Dimension int32

The dimensions of the mediation report. Dimensions are data attributes to break down or refine the quantitative measurements (metrics) by certain attributes, such as the ad format or the platform an ad was viewed on.

const (
	// Default value for an unset field. Do not use.
	MediationReportSpec_DIMENSION_UNSPECIFIED MediationReportSpec_Dimension = 0
	// A date in the YYYY-MM-DD format (for example, "2018-12-21"). Requests can
	// specify at most one time dimension.
	MediationReportSpec_DATE MediationReportSpec_Dimension = 1
	// A month in the YYYY-MM format (for example, "2018-12"). Requests can
	// specify at most one time dimension.
	MediationReportSpec_MONTH MediationReportSpec_Dimension = 2
	// The date of the first day of a week in the YYYY-MM-DD format
	// (for example, "2018-12-21"). Requests can specify at most one time
	// dimension.
	MediationReportSpec_WEEK MediationReportSpec_Dimension = 3
	// The unique ID of the ad source (for example, "5450213213286189855" and
	// "AdMob Network" as label value).
	MediationReportSpec_AD_SOURCE MediationReportSpec_Dimension = 4
	// The unique ID of the ad source instance (for example,
	// "ca-app-pub-1234#5678" and "AdMob (default)" as label value).
	//
	// **Warning:** The dimension is incompatible with
	// [ESTIMATED_EARNINGS](#Metric.ENUM_VALUES.ESTIMATED_EARNINGS) and
	// [OBSERVED_ECPM](#Metric.ENUM_VALUES.OBSERVED_ECPM) metrics.
	MediationReportSpec_AD_SOURCE_INSTANCE MediationReportSpec_Dimension = 5
	// The unique ID of the ad unit (for example, "ca-app-pub-1234/8790").
	// If AD_UNIT dimension is specified, then APP is included automatically.
	MediationReportSpec_AD_UNIT MediationReportSpec_Dimension = 6
	// The unique ID of the mobile application (for example,
	// "ca-app-pub-1234~1234").
	MediationReportSpec_APP MediationReportSpec_Dimension = 7
	// The unique ID of the mediation group (for example,
	// "ca-app-pub-1234:mg:1234" and "AdMob (default)" as label value).
	//
	// **Warning:** The dimension is incompatible with
	// [ESTIMATED_EARNINGS](#Metric.ENUM_VALUES.ESTIMATED_EARNINGS) and
	// [OBSERVED_ECPM](#Metric.ENUM_VALUES.OBSERVED_ECPM) metrics.
	MediationReportSpec_MEDIATION_GROUP MediationReportSpec_Dimension = 11
	// CLDR country code of the place where the ad views/clicks occur (for
	// example, "US" or "FR"). This is a geography dimension.
	MediationReportSpec_COUNTRY MediationReportSpec_Dimension = 8
	// Format of the ad unit (for example, "banner", "native"), an ad delivery
	// dimension.
	MediationReportSpec_FORMAT MediationReportSpec_Dimension = 9
	// Mobile OS platform of the app (for example, "Android" or "iOS").
	MediationReportSpec_PLATFORM MediationReportSpec_Dimension = 10
)

func (MediationReportSpec_Dimension) Descriptor

func (MediationReportSpec_Dimension) Enum

func (MediationReportSpec_Dimension) EnumDescriptor deprecated

func (MediationReportSpec_Dimension) EnumDescriptor() ([]byte, []int)

Deprecated: Use MediationReportSpec_Dimension.Descriptor instead.

func (MediationReportSpec_Dimension) Number

func (MediationReportSpec_Dimension) String

func (MediationReportSpec_Dimension) Type

type MediationReportSpec_DimensionFilter

type MediationReportSpec_DimensionFilter struct {

	// Applies the filter criterion to the specified dimension.
	Dimension MediationReportSpec_Dimension `` /* 127-byte string literal not displayed */
	// Filter operator to be applied.
	//
	// Types that are assignable to Operator:
	//	*MediationReportSpec_DimensionFilter_MatchesAny
	Operator isMediationReportSpec_DimensionFilter_Operator `protobuf_oneof:"operator"`
	// contains filtered or unexported fields
}

Describes which report rows to match based on their dimension values.

func (*MediationReportSpec_DimensionFilter) Descriptor deprecated

func (*MediationReportSpec_DimensionFilter) Descriptor() ([]byte, []int)

Deprecated: Use MediationReportSpec_DimensionFilter.ProtoReflect.Descriptor instead.

func (*MediationReportSpec_DimensionFilter) GetDimension

func (*MediationReportSpec_DimensionFilter) GetMatchesAny

func (x *MediationReportSpec_DimensionFilter) GetMatchesAny() *StringList

func (*MediationReportSpec_DimensionFilter) GetOperator

func (m *MediationReportSpec_DimensionFilter) GetOperator() isMediationReportSpec_DimensionFilter_Operator

func (*MediationReportSpec_DimensionFilter) ProtoMessage

func (*MediationReportSpec_DimensionFilter) ProtoMessage()

func (*MediationReportSpec_DimensionFilter) ProtoReflect

func (*MediationReportSpec_DimensionFilter) Reset

func (*MediationReportSpec_DimensionFilter) String

type MediationReportSpec_DimensionFilter_MatchesAny

type MediationReportSpec_DimensionFilter_MatchesAny struct {
	// Matches a row if its value for the specified dimension is in one of the
	// values specified in this condition.
	MatchesAny *StringList `protobuf:"bytes,2,opt,name=matches_any,json=matchesAny,proto3,oneof"`
}

type MediationReportSpec_Metric

type MediationReportSpec_Metric int32

The metrics of the mediation report. Metrics are quantitative measurements indicating how the publisher business is performing. They are aggregated from the individual ad events and grouped by the report dimensions. The metric value is either integer, or decimal (without rounding).

const (
	// Default value for an unset field. Do not use.
	MediationReportSpec_METRIC_UNSPECIFIED MediationReportSpec_Metric = 0
	// The number of requests. The value is an integer.
	MediationReportSpec_AD_REQUESTS MediationReportSpec_Metric = 1
	// The number of times a user clicks an ad. The value is an integer.
	MediationReportSpec_CLICKS MediationReportSpec_Metric = 2
	// The estimated earnings of the AdMob publisher. The currency unit (USD,
	// EUR, or other) of the earning metrics are determined by the localization
	// setting for currency. The amount is in micros. For example, $6.50 would
	// be represented as 6500000.
	//
	// **Warning:** The metric is incompatible with
	// [AD_SOURCE_INSTANCE](#Dimension.ENUM_VALUES.AD_SOURCE_INSTANCE) and
	// [MEDIATION_GROUP](#Dimension.ENUM_VALUES.MEDIATION_GROUP) dimensions.
	MediationReportSpec_ESTIMATED_EARNINGS MediationReportSpec_Metric = 3
	// The total number of ads shown to users. The value is an integer.
	MediationReportSpec_IMPRESSIONS MediationReportSpec_Metric = 4
	// The ratio of clicks over impressions. The value is a double precision
	// (approximate) decimal value.
	MediationReportSpec_IMPRESSION_CTR MediationReportSpec_Metric = 5
	// The number of times ads are returned in response to a request. The value
	// is an integer.
	MediationReportSpec_MATCHED_REQUESTS MediationReportSpec_Metric = 6
	// The ratio of matched ad requests over the total ad requests. The value is
	// a double precision (approximate) decimal value.
	MediationReportSpec_MATCH_RATE MediationReportSpec_Metric = 7
	// The third-party ad network's estimated average eCPM. The currency unit
	// (USD, EUR, or other) of the earning metrics are determined by the
	// localization setting for currency. The amount is in micros. For example,
	// $2.30 would be represented as 2300000.
	//
	// **Warning:** The metric is incompatible with
	// [AD_SOURCE_INSTANCE](#Dimension.ENUM_VALUES.AD_SOURCE_INSTANCE) and
	// [MEDIATION_GROUP](#Dimension.ENUM_VALUES.MEDIATION_GROUP) dimensions.
	MediationReportSpec_OBSERVED_ECPM MediationReportSpec_Metric = 8
)

func (MediationReportSpec_Metric) Descriptor

func (MediationReportSpec_Metric) Enum

func (MediationReportSpec_Metric) EnumDescriptor deprecated

func (MediationReportSpec_Metric) EnumDescriptor() ([]byte, []int)

Deprecated: Use MediationReportSpec_Metric.Descriptor instead.

func (MediationReportSpec_Metric) Number

func (MediationReportSpec_Metric) String

func (MediationReportSpec_Metric) Type

type MediationReportSpec_SortCondition

type MediationReportSpec_SortCondition struct {

	// Identifies which values to sort on.
	//
	// Types that are assignable to SortOn:
	//	*MediationReportSpec_SortCondition_Dimension
	//	*MediationReportSpec_SortCondition_Metric
	SortOn isMediationReportSpec_SortCondition_SortOn `protobuf_oneof:"sort_on"`
	// Sorting order of the dimension or metric.
	Order SortOrder `protobuf:"varint,3,opt,name=order,proto3,enum=google.ads.admob.v1.SortOrder" json:"order,omitempty"`
	// contains filtered or unexported fields
}

Sorting direction to be applied on a dimension or a metric.

func (*MediationReportSpec_SortCondition) Descriptor deprecated

func (*MediationReportSpec_SortCondition) Descriptor() ([]byte, []int)

Deprecated: Use MediationReportSpec_SortCondition.ProtoReflect.Descriptor instead.

func (*MediationReportSpec_SortCondition) GetDimension

func (*MediationReportSpec_SortCondition) GetMetric

func (*MediationReportSpec_SortCondition) GetOrder

func (*MediationReportSpec_SortCondition) GetSortOn

func (m *MediationReportSpec_SortCondition) GetSortOn() isMediationReportSpec_SortCondition_SortOn

func (*MediationReportSpec_SortCondition) ProtoMessage

func (*MediationReportSpec_SortCondition) ProtoMessage()

func (*MediationReportSpec_SortCondition) ProtoReflect

func (*MediationReportSpec_SortCondition) Reset

func (*MediationReportSpec_SortCondition) String

type MediationReportSpec_SortCondition_Dimension

type MediationReportSpec_SortCondition_Dimension struct {
	// Sort by the specified dimension.
	Dimension MediationReportSpec_Dimension `protobuf:"varint,1,opt,name=dimension,proto3,enum=google.ads.admob.v1.MediationReportSpec_Dimension,oneof"`
}

type MediationReportSpec_SortCondition_Metric

type MediationReportSpec_SortCondition_Metric struct {
	// Sort by the specified metric.
	Metric MediationReportSpec_Metric `protobuf:"varint,2,opt,name=metric,proto3,enum=google.ads.admob.v1.MediationReportSpec_Metric,oneof"`
}

type NetworkReportSpec

type NetworkReportSpec struct {

	// The date range for which the report is generated.
	DateRange *DateRange `protobuf:"bytes,1,opt,name=date_range,json=dateRange,proto3" json:"date_range,omitempty"`
	// List of dimensions of the report. The value combination of these dimensions
	// determines the row of the report. If no dimensions are specified, the
	// report returns a single row of requested metrics for the entire account.
	Dimensions []NetworkReportSpec_Dimension `` /* 134-byte string literal not displayed */
	// List of metrics of the report. A report must specify at least one metric.
	Metrics []NetworkReportSpec_Metric `protobuf:"varint,3,rep,packed,name=metrics,proto3,enum=google.ads.admob.v1.NetworkReportSpec_Metric" json:"metrics,omitempty"`
	// Describes which report rows to match based on their dimension values.
	DimensionFilters []*NetworkReportSpec_DimensionFilter `protobuf:"bytes,4,rep,name=dimension_filters,json=dimensionFilters,proto3" json:"dimension_filters,omitempty"`
	// Describes the sorting of report rows. The order of the condition in the
	// list defines its precedence; the earlier the condition, the higher its
	// precedence. If no sort conditions are specified, the row ordering is
	// undefined.
	SortConditions []*NetworkReportSpec_SortCondition `protobuf:"bytes,5,rep,name=sort_conditions,json=sortConditions,proto3" json:"sort_conditions,omitempty"`
	// Localization settings of the report.
	LocalizationSettings *LocalizationSettings `protobuf:"bytes,6,opt,name=localization_settings,json=localizationSettings,proto3" json:"localization_settings,omitempty"`
	// Maximum number of report data rows to return. If the value is not set, the
	// API returns as many rows as possible, up to 100000. Acceptable values are
	// 1-100000, inclusive. Any other values are treated as 100000.
	MaxReportRows int32 `protobuf:"varint,7,opt,name=max_report_rows,json=maxReportRows,proto3" json:"max_report_rows,omitempty"`
	// A report time zone. Accepts an IANA TZ name values, such as
	// "America/Los_Angeles."  If no time zone is defined, the account default
	// takes effect. Check default value by the get account action.
	//
	// **Warning:** The "America/Los_Angeles" is the only supported value at
	// the moment.
	TimeZone string `protobuf:"bytes,8,opt,name=time_zone,json=timeZone,proto3" json:"time_zone,omitempty"`
	// contains filtered or unexported fields
}

The specification for generating an AdMob Network report. For example, the specification to get clicks and estimated earnings for only the 'US' and 'CN' countries can look like the following example:

{
  'date_range': {
    'start_date': {'year': 2018, 'month': 9, 'day': 1},
    'end_date': {'year': 2018, 'month': 9, 'day': 30}
  },
  'dimensions': ['DATE', 'APP', 'COUNTRY'],
  'metrics': ['CLICKS', 'ESTIMATED_EARNINGS'],
  'dimension_filters': [
    {
      'dimension': 'COUNTRY',
      'matches_any': {'values': [{'value': 'US', 'value': 'CN'}]}
    }
  ],
  'sort_conditions': [
    {'dimension':'APP', order: 'ASCENDING'},
    {'metric':'CLICKS', order: 'DESCENDING'}
  ],
  'localization_settings': {
    'currency_code': 'USD',
    'language_code': 'en-US'
  }
}

For a better understanding, you can treat the preceding specification like the following pseudo SQL:

SELECT DATE, APP, COUNTRY, CLICKS, ESTIMATED_EARNINGS
FROM NETWORK_REPORT
WHERE DATE >= '2018-09-01' AND DATE <= '2018-09-30'
    AND COUNTRY IN ('US', 'CN')
GROUP BY DATE, APP, COUNTRY
ORDER BY APP ASC, CLICKS DESC;

func (*NetworkReportSpec) Descriptor deprecated

func (*NetworkReportSpec) Descriptor() ([]byte, []int)

Deprecated: Use NetworkReportSpec.ProtoReflect.Descriptor instead.

func (*NetworkReportSpec) GetDateRange

func (x *NetworkReportSpec) GetDateRange() *DateRange

func (*NetworkReportSpec) GetDimensionFilters

func (x *NetworkReportSpec) GetDimensionFilters() []*NetworkReportSpec_DimensionFilter

func (*NetworkReportSpec) GetDimensions

func (x *NetworkReportSpec) GetDimensions() []NetworkReportSpec_Dimension

func (*NetworkReportSpec) GetLocalizationSettings

func (x *NetworkReportSpec) GetLocalizationSettings() *LocalizationSettings

func (*NetworkReportSpec) GetMaxReportRows

func (x *NetworkReportSpec) GetMaxReportRows() int32

func (*NetworkReportSpec) GetMetrics

func (x *NetworkReportSpec) GetMetrics() []NetworkReportSpec_Metric

func (*NetworkReportSpec) GetSortConditions

func (x *NetworkReportSpec) GetSortConditions() []*NetworkReportSpec_SortCondition

func (*NetworkReportSpec) GetTimeZone

func (x *NetworkReportSpec) GetTimeZone() string

func (*NetworkReportSpec) ProtoMessage

func (*NetworkReportSpec) ProtoMessage()

func (*NetworkReportSpec) ProtoReflect

func (x *NetworkReportSpec) ProtoReflect() protoreflect.Message

func (*NetworkReportSpec) Reset

func (x *NetworkReportSpec) Reset()

func (*NetworkReportSpec) String

func (x *NetworkReportSpec) String() string

type NetworkReportSpec_Dimension

type NetworkReportSpec_Dimension int32

The dimensions of the network report. Dimensions are data attributes to break down or refine the quantitative measurements (metrics) by certain attributes, such as the ad format or the platform an ad was viewed on.

const (
	// Default value for an unset field. Do not use.
	NetworkReportSpec_DIMENSION_UNSPECIFIED NetworkReportSpec_Dimension = 0
	// A date in the YYYY-MM-DD format (for example, "2018-12-21"). Requests can
	// specify at most one time dimension.
	NetworkReportSpec_DATE NetworkReportSpec_Dimension = 1
	// A month in the YYYY-MM format (for example, "2018-12"). Requests can
	// specify at most one time dimension.
	NetworkReportSpec_MONTH NetworkReportSpec_Dimension = 2
	// The date of the first day of a week in the YYYY-MM-DD format
	// (for example, "2018-12-21"). Requests can specify at most one time
	// dimension.
	NetworkReportSpec_WEEK NetworkReportSpec_Dimension = 3
	// The unique ID of the ad unit (for example, "ca-app-pub-1234/1234").
	// If AD_UNIT dimension is specified, then APP is included automatically.
	NetworkReportSpec_AD_UNIT NetworkReportSpec_Dimension = 4
	// The unique ID of the mobile application (for example,
	// "ca-app-pub-1234~1234").
	NetworkReportSpec_APP NetworkReportSpec_Dimension = 5
	// Type of the ad (for example, "text" or "image"), an ad delivery
	// dimension.
	//
	// **Warning:** The dimension is incompatible with
	// [AD_REQUESTS](#Metric.ENUM_VALUES.AD_REQUESTS),
	// [MATCH_RATE](#Metric.ENUM_VALUES.MATCH_RATE) and
	// [IMPRESSION_RPM](#Metric.ENUM_VALUES.IMPRESSION_RPM) metrics.
	NetworkReportSpec_AD_TYPE NetworkReportSpec_Dimension = 6
	// CLDR country code of the place where the ad views/clicks occur (for
	// example, "US" or "FR"). This is a geography dimension.
	NetworkReportSpec_COUNTRY NetworkReportSpec_Dimension = 7
	// Format of the ad unit (for example, "banner", "native"), an ad delivery
	// dimension.
	NetworkReportSpec_FORMAT NetworkReportSpec_Dimension = 8
	// Mobile OS platform of the app (for example, "Android" or "iOS").
	NetworkReportSpec_PLATFORM NetworkReportSpec_Dimension = 9
)

func (NetworkReportSpec_Dimension) Descriptor

func (NetworkReportSpec_Dimension) Enum

func (NetworkReportSpec_Dimension) EnumDescriptor deprecated

func (NetworkReportSpec_Dimension) EnumDescriptor() ([]byte, []int)

Deprecated: Use NetworkReportSpec_Dimension.Descriptor instead.

func (NetworkReportSpec_Dimension) Number

func (NetworkReportSpec_Dimension) String

func (NetworkReportSpec_Dimension) Type

type NetworkReportSpec_DimensionFilter

type NetworkReportSpec_DimensionFilter struct {

	// Applies the filter criterion to the specified dimension.
	Dimension NetworkReportSpec_Dimension `protobuf:"varint,1,opt,name=dimension,proto3,enum=google.ads.admob.v1.NetworkReportSpec_Dimension" json:"dimension,omitempty"`
	// Filter operator to be applied.
	//
	// Types that are assignable to Operator:
	//	*NetworkReportSpec_DimensionFilter_MatchesAny
	Operator isNetworkReportSpec_DimensionFilter_Operator `protobuf_oneof:"operator"`
	// contains filtered or unexported fields
}

Describes which report rows to match based on their dimension values.

func (*NetworkReportSpec_DimensionFilter) Descriptor deprecated

func (*NetworkReportSpec_DimensionFilter) Descriptor() ([]byte, []int)

Deprecated: Use NetworkReportSpec_DimensionFilter.ProtoReflect.Descriptor instead.

func (*NetworkReportSpec_DimensionFilter) GetDimension

func (*NetworkReportSpec_DimensionFilter) GetMatchesAny

func (x *NetworkReportSpec_DimensionFilter) GetMatchesAny() *StringList

func (*NetworkReportSpec_DimensionFilter) GetOperator

func (m *NetworkReportSpec_DimensionFilter) GetOperator() isNetworkReportSpec_DimensionFilter_Operator

func (*NetworkReportSpec_DimensionFilter) ProtoMessage

func (*NetworkReportSpec_DimensionFilter) ProtoMessage()

func (*NetworkReportSpec_DimensionFilter) ProtoReflect

func (*NetworkReportSpec_DimensionFilter) Reset

func (*NetworkReportSpec_DimensionFilter) String

type NetworkReportSpec_DimensionFilter_MatchesAny

type NetworkReportSpec_DimensionFilter_MatchesAny struct {
	// Matches a row if its value for the specified dimension is in one of the
	// values specified in this condition.
	MatchesAny *StringList `protobuf:"bytes,2,opt,name=matches_any,json=matchesAny,proto3,oneof"`
}

type NetworkReportSpec_Metric

type NetworkReportSpec_Metric int32

The metrics of the network report. Metrics are quantitative measurements indicating how the publisher business is performing. They are aggregated from the individual ad events and grouped by the report dimensions. The metric value is either integer, or decimal (without rounding).

const (
	// Default value for an unset field. Do not use.
	NetworkReportSpec_METRIC_UNSPECIFIED NetworkReportSpec_Metric = 0
	// The number of ad requests. The value is an integer.
	//
	// **Warning:** The metric is incompatible with
	// [AD_TYPE](#Dimension.ENUM_VALUES.AD_TYPE) dimension.
	NetworkReportSpec_AD_REQUESTS NetworkReportSpec_Metric = 1
	// The number of times a user clicks an ad. The value is an integer.
	NetworkReportSpec_CLICKS NetworkReportSpec_Metric = 2
	// The estimated earnings of the AdMob publisher. The currency unit (USD,
	// EUR, or other) of the earning metrics are determined by the localization
	// setting for currency. The amount is in micros. For example, $6.50 would
	// be represented as 6500000.
	NetworkReportSpec_ESTIMATED_EARNINGS NetworkReportSpec_Metric = 3
	// The total number of ads shown to users. The value is an integer.
	NetworkReportSpec_IMPRESSIONS NetworkReportSpec_Metric = 4
	// The ratio of clicks over impressions. The value is a double precision
	// (approximate) decimal value.
	NetworkReportSpec_IMPRESSION_CTR NetworkReportSpec_Metric = 5
	// The estimated earnings per thousand ad impressions. The value is in
	// micros. For example, $1.03 would be represented as 1030000.
	//
	// **Warning:** The metric is incompatible with
	// [AD_TYPE](#Dimension.ENUM_VALUES.AD_TYPE) dimension.
	NetworkReportSpec_IMPRESSION_RPM NetworkReportSpec_Metric = 6
	// The number of times ads are returned in response to a request. The value
	// is an integer.
	NetworkReportSpec_MATCHED_REQUESTS NetworkReportSpec_Metric = 7
	// The ratio of matched ad requests over the total ad requests. The value is
	// a double precision (approximate) decimal value.
	//
	// **Warning:** The metric is incompatible with
	// [AD_TYPE](#Dimension.ENUM_VALUES.AD_TYPE) dimension.
	NetworkReportSpec_MATCH_RATE NetworkReportSpec_Metric = 8
	// The ratio of ads that are displayed over ads that are returned, defined
	// as impressions / matched requests. The value is a double precision
	// (approximate) decimal value.
	NetworkReportSpec_SHOW_RATE NetworkReportSpec_Metric = 9
)

func (NetworkReportSpec_Metric) Descriptor

func (NetworkReportSpec_Metric) Enum

func (NetworkReportSpec_Metric) EnumDescriptor deprecated

func (NetworkReportSpec_Metric) EnumDescriptor() ([]byte, []int)

Deprecated: Use NetworkReportSpec_Metric.Descriptor instead.

func (NetworkReportSpec_Metric) Number

func (NetworkReportSpec_Metric) String

func (x NetworkReportSpec_Metric) String() string

func (NetworkReportSpec_Metric) Type

type NetworkReportSpec_SortCondition

type NetworkReportSpec_SortCondition struct {

	// Identifies which values to sort on.
	//
	// Types that are assignable to SortOn:
	//	*NetworkReportSpec_SortCondition_Dimension
	//	*NetworkReportSpec_SortCondition_Metric
	SortOn isNetworkReportSpec_SortCondition_SortOn `protobuf_oneof:"sort_on"`
	// Sorting order of the dimension or metric.
	Order SortOrder `protobuf:"varint,3,opt,name=order,proto3,enum=google.ads.admob.v1.SortOrder" json:"order,omitempty"`
	// contains filtered or unexported fields
}

Sorting direction to be applied on a dimension or a metric.

func (*NetworkReportSpec_SortCondition) Descriptor deprecated

func (*NetworkReportSpec_SortCondition) Descriptor() ([]byte, []int)

Deprecated: Use NetworkReportSpec_SortCondition.ProtoReflect.Descriptor instead.

func (*NetworkReportSpec_SortCondition) GetDimension

func (*NetworkReportSpec_SortCondition) GetMetric

func (*NetworkReportSpec_SortCondition) GetOrder

func (*NetworkReportSpec_SortCondition) GetSortOn

func (m *NetworkReportSpec_SortCondition) GetSortOn() isNetworkReportSpec_SortCondition_SortOn

func (*NetworkReportSpec_SortCondition) ProtoMessage

func (*NetworkReportSpec_SortCondition) ProtoMessage()

func (*NetworkReportSpec_SortCondition) ProtoReflect

func (*NetworkReportSpec_SortCondition) Reset

func (*NetworkReportSpec_SortCondition) String

type NetworkReportSpec_SortCondition_Dimension

type NetworkReportSpec_SortCondition_Dimension struct {
	// Sort by the specified dimension.
	Dimension NetworkReportSpec_Dimension `protobuf:"varint,1,opt,name=dimension,proto3,enum=google.ads.admob.v1.NetworkReportSpec_Dimension,oneof"`
}

type NetworkReportSpec_SortCondition_Metric

type NetworkReportSpec_SortCondition_Metric struct {
	// Sort by the specified metric.
	Metric NetworkReportSpec_Metric `protobuf:"varint,2,opt,name=metric,proto3,enum=google.ads.admob.v1.NetworkReportSpec_Metric,oneof"`
}

type PublisherAccount

type PublisherAccount struct {

	// Resource name of this account.
	// Format is accounts/{publisher_id}.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The unique ID by which this publisher account can be identified
	// in the API requests (for example, pub-1234567890).
	PublisherId string `protobuf:"bytes,2,opt,name=publisher_id,json=publisherId,proto3" json:"publisher_id,omitempty"`
	// The time zone that is used in reports that are generated for this account.
	// The value is a time-zone ID as specified by the CLDR project,
	// for example, "America/Los_Angeles".
	ReportingTimeZone string `protobuf:"bytes,3,opt,name=reporting_time_zone,json=reportingTimeZone,proto3" json:"reporting_time_zone,omitempty"`
	// Currency code of the earning-related metrics, which is the 3-letter code
	// defined in ISO 4217. The daily average rate is used for the currency
	// conversion.
	CurrencyCode string `protobuf:"bytes,4,opt,name=currency_code,json=currencyCode,proto3" json:"currency_code,omitempty"`
	// contains filtered or unexported fields
}

A publisher account contains information relevant to the use of this API, such as the time zone used for the reports.

func (*PublisherAccount) Descriptor deprecated

func (*PublisherAccount) Descriptor() ([]byte, []int)

Deprecated: Use PublisherAccount.ProtoReflect.Descriptor instead.

func (*PublisherAccount) GetCurrencyCode

func (x *PublisherAccount) GetCurrencyCode() string

func (*PublisherAccount) GetName

func (x *PublisherAccount) GetName() string

func (*PublisherAccount) GetPublisherId

func (x *PublisherAccount) GetPublisherId() string

func (*PublisherAccount) GetReportingTimeZone

func (x *PublisherAccount) GetReportingTimeZone() string

func (*PublisherAccount) ProtoMessage

func (*PublisherAccount) ProtoMessage()

func (*PublisherAccount) ProtoReflect

func (x *PublisherAccount) ProtoReflect() protoreflect.Message

func (*PublisherAccount) Reset

func (x *PublisherAccount) Reset()

func (*PublisherAccount) String

func (x *PublisherAccount) String() string

type ReportFooter

type ReportFooter struct {

	// Warnings associated with generation of the report.
	Warnings []*ReportWarning `protobuf:"bytes,1,rep,name=warnings,proto3" json:"warnings,omitempty"`
	// Total number of rows that did match the request.
	MatchingRowCount int64 `protobuf:"varint,2,opt,name=matching_row_count,json=matchingRowCount,proto3" json:"matching_row_count,omitempty"`
	// contains filtered or unexported fields
}

Groups data available after report generation, for example, warnings and row counts. Always sent as the last message in the stream response.

func (*ReportFooter) Descriptor deprecated

func (*ReportFooter) Descriptor() ([]byte, []int)

Deprecated: Use ReportFooter.ProtoReflect.Descriptor instead.

func (*ReportFooter) GetMatchingRowCount

func (x *ReportFooter) GetMatchingRowCount() int64

func (*ReportFooter) GetWarnings

func (x *ReportFooter) GetWarnings() []*ReportWarning

func (*ReportFooter) ProtoMessage

func (*ReportFooter) ProtoMessage()

func (*ReportFooter) ProtoReflect

func (x *ReportFooter) ProtoReflect() protoreflect.Message

func (*ReportFooter) Reset

func (x *ReportFooter) Reset()

func (*ReportFooter) String

func (x *ReportFooter) String() string

type ReportHeader

type ReportHeader struct {

	// The date range for which the report is generated. This is identical to the
	// range specified in the report request.
	DateRange *DateRange `protobuf:"bytes,1,opt,name=date_range,json=dateRange,proto3" json:"date_range,omitempty"`
	// Localization settings of the report. This is identical to the settings
	// in the report request.
	LocalizationSettings *LocalizationSettings `protobuf:"bytes,2,opt,name=localization_settings,json=localizationSettings,proto3" json:"localization_settings,omitempty"`
	// The report time zone. The value is a time-zone ID as specified by the CLDR
	// project, for example, "America/Los_Angeles".
	ReportingTimeZone string `protobuf:"bytes,3,opt,name=reporting_time_zone,json=reportingTimeZone,proto3" json:"reporting_time_zone,omitempty"`
	// contains filtered or unexported fields
}

Groups data helps to treat the generated report. Always sent as a first message in the stream response.

func (*ReportHeader) Descriptor deprecated

func (*ReportHeader) Descriptor() ([]byte, []int)

Deprecated: Use ReportHeader.ProtoReflect.Descriptor instead.

func (*ReportHeader) GetDateRange

func (x *ReportHeader) GetDateRange() *DateRange

func (*ReportHeader) GetLocalizationSettings

func (x *ReportHeader) GetLocalizationSettings() *LocalizationSettings

func (*ReportHeader) GetReportingTimeZone

func (x *ReportHeader) GetReportingTimeZone() string

func (*ReportHeader) ProtoMessage

func (*ReportHeader) ProtoMessage()

func (*ReportHeader) ProtoReflect

func (x *ReportHeader) ProtoReflect() protoreflect.Message

func (*ReportHeader) Reset

func (x *ReportHeader) Reset()

func (*ReportHeader) String

func (x *ReportHeader) String() string

type ReportRow

type ReportRow struct {

	// Map of dimension values in a row, with keys as enum name of the dimensions.
	DimensionValues map[string]*ReportRow_DimensionValue `` /* 194-byte string literal not displayed */
	// Map of metric values in a row, with keys as enum name of the metrics. If
	// a metric being requested has no value returned, the map will not include
	// it.
	MetricValues map[string]*ReportRow_MetricValue `` /* 185-byte string literal not displayed */
	// contains filtered or unexported fields
}

A row of the returning report.

func (*ReportRow) Descriptor deprecated

func (*ReportRow) Descriptor() ([]byte, []int)

Deprecated: Use ReportRow.ProtoReflect.Descriptor instead.

func (*ReportRow) GetDimensionValues

func (x *ReportRow) GetDimensionValues() map[string]*ReportRow_DimensionValue

func (*ReportRow) GetMetricValues

func (x *ReportRow) GetMetricValues() map[string]*ReportRow_MetricValue

func (*ReportRow) ProtoMessage

func (*ReportRow) ProtoMessage()

func (*ReportRow) ProtoReflect

func (x *ReportRow) ProtoReflect() protoreflect.Message

func (*ReportRow) Reset

func (x *ReportRow) Reset()

func (*ReportRow) String

func (x *ReportRow) String() string

type ReportRow_DimensionValue

type ReportRow_DimensionValue struct {

	// Dimension value in the format specified in the report's spec Dimension
	// enum.
	Value string `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`
	// The localized string representation of the value. If unspecified, the
	// display label should be derived from the value.
	DisplayLabel string `protobuf:"bytes,2,opt,name=display_label,json=displayLabel,proto3" json:"display_label,omitempty"`
	// contains filtered or unexported fields
}

Representation of a dimension value.

func (*ReportRow_DimensionValue) Descriptor deprecated

func (*ReportRow_DimensionValue) Descriptor() ([]byte, []int)

Deprecated: Use ReportRow_DimensionValue.ProtoReflect.Descriptor instead.

func (*ReportRow_DimensionValue) GetDisplayLabel

func (x *ReportRow_DimensionValue) GetDisplayLabel() string

func (*ReportRow_DimensionValue) GetValue

func (x *ReportRow_DimensionValue) GetValue() string

func (*ReportRow_DimensionValue) ProtoMessage

func (*ReportRow_DimensionValue) ProtoMessage()

func (*ReportRow_DimensionValue) ProtoReflect

func (x *ReportRow_DimensionValue) ProtoReflect() protoreflect.Message

func (*ReportRow_DimensionValue) Reset

func (x *ReportRow_DimensionValue) Reset()

func (*ReportRow_DimensionValue) String

func (x *ReportRow_DimensionValue) String() string

type ReportRow_MetricValue

type ReportRow_MetricValue struct {

	// Metric value in the format specified in the report's spec Metric enum
	// name.
	//
	// Types that are assignable to Value:
	//	*ReportRow_MetricValue_IntegerValue
	//	*ReportRow_MetricValue_DoubleValue
	//	*ReportRow_MetricValue_MicrosValue
	Value isReportRow_MetricValue_Value `protobuf_oneof:"value"`
	// contains filtered or unexported fields
}

Representation of a metric value.

func (*ReportRow_MetricValue) Descriptor deprecated

func (*ReportRow_MetricValue) Descriptor() ([]byte, []int)

Deprecated: Use ReportRow_MetricValue.ProtoReflect.Descriptor instead.

func (*ReportRow_MetricValue) GetDoubleValue

func (x *ReportRow_MetricValue) GetDoubleValue() float64

func (*ReportRow_MetricValue) GetIntegerValue

func (x *ReportRow_MetricValue) GetIntegerValue() int64

func (*ReportRow_MetricValue) GetMicrosValue

func (x *ReportRow_MetricValue) GetMicrosValue() int64

func (*ReportRow_MetricValue) GetValue

func (m *ReportRow_MetricValue) GetValue() isReportRow_MetricValue_Value

func (*ReportRow_MetricValue) ProtoMessage

func (*ReportRow_MetricValue) ProtoMessage()

func (*ReportRow_MetricValue) ProtoReflect

func (x *ReportRow_MetricValue) ProtoReflect() protoreflect.Message

func (*ReportRow_MetricValue) Reset

func (x *ReportRow_MetricValue) Reset()

func (*ReportRow_MetricValue) String

func (x *ReportRow_MetricValue) String() string

type ReportRow_MetricValue_DoubleValue

type ReportRow_MetricValue_DoubleValue struct {
	// Double precision (approximate) decimal values. Rates are from 0 to 1.
	DoubleValue float64 `protobuf:"fixed64,2,opt,name=double_value,json=doubleValue,proto3,oneof"`
}

type ReportRow_MetricValue_IntegerValue

type ReportRow_MetricValue_IntegerValue struct {
	// Metric integer value.
	IntegerValue int64 `protobuf:"varint,1,opt,name=integer_value,json=integerValue,proto3,oneof"`
}

type ReportRow_MetricValue_MicrosValue

type ReportRow_MetricValue_MicrosValue struct {
	// Amount in micros. One million is equivalent to one unit. Currency value
	// is in the unit (USD, EUR or other) specified by the request.
	// For example, $6.50 whould be represented as 6500000 micros.
	MicrosValue int64 `protobuf:"varint,3,opt,name=micros_value,json=microsValue,proto3,oneof"`
}

type ReportWarning

type ReportWarning struct {

	// Type of the warning.
	Type ReportWarning_Type `protobuf:"varint,1,opt,name=type,proto3,enum=google.ads.admob.v1.ReportWarning_Type" json:"type,omitempty"`
	// Describes the details of the warning message, in English.
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// contains filtered or unexported fields
}

Warnings associated with generation of the report.

func (*ReportWarning) Descriptor deprecated

func (*ReportWarning) Descriptor() ([]byte, []int)

Deprecated: Use ReportWarning.ProtoReflect.Descriptor instead.

func (*ReportWarning) GetDescription

func (x *ReportWarning) GetDescription() string

func (*ReportWarning) GetType

func (x *ReportWarning) GetType() ReportWarning_Type

func (*ReportWarning) ProtoMessage

func (*ReportWarning) ProtoMessage()

func (*ReportWarning) ProtoReflect

func (x *ReportWarning) ProtoReflect() protoreflect.Message

func (*ReportWarning) Reset

func (x *ReportWarning) Reset()

func (*ReportWarning) String

func (x *ReportWarning) String() string

type ReportWarning_Type

type ReportWarning_Type int32

Warning type.

const (
	// Default value for an unset field. Do not use.
	ReportWarning_TYPE_UNSPECIFIED ReportWarning_Type = 0
	// Some data in this report is aggregated based on a time zone different
	// from the requested time zone. This could happen if a local time-zone
	// report has the start time before the last time this time zone changed.
	// The description field will contain the date of the last time zone
	// change.
	ReportWarning_DATA_BEFORE_ACCOUNT_TIMEZONE_CHANGE ReportWarning_Type = 1
	// There is an unusual delay in processing the source data for the
	// requested date range. The report results might be less up to date than
	// usual. AdMob is aware of the issue and is actively working to resolve
	// it.
	ReportWarning_DATA_DELAYED ReportWarning_Type = 2
	// Warnings that are exposed without a specific type. Useful when new
	// warning types are added but the API is not changed yet.
	ReportWarning_OTHER ReportWarning_Type = 3
	// The currency being requested is not the account currency. The earning
	// metrics will be based on the requested currency, and thus not a good
	// estimation of the final payment anymore, due to the currency rate
	// fluctuation.
	ReportWarning_REPORT_CURRENCY_NOT_ACCOUNT_CURRENCY ReportWarning_Type = 4
)

func (ReportWarning_Type) Descriptor

func (ReportWarning_Type) Enum

func (ReportWarning_Type) EnumDescriptor deprecated

func (ReportWarning_Type) EnumDescriptor() ([]byte, []int)

Deprecated: Use ReportWarning_Type.Descriptor instead.

func (ReportWarning_Type) Number

func (ReportWarning_Type) String

func (x ReportWarning_Type) String() string

func (ReportWarning_Type) Type

type SortOrder

type SortOrder int32

The sorting order.

const (
	// Default value for an unset field. Do not use.
	SortOrder_SORT_ORDER_UNSPECIFIED SortOrder = 0
	// Sort dimension value or metric value in ascending order.
	SortOrder_ASCENDING SortOrder = 1
	// Sort dimension value or metric value in descending order.
	SortOrder_DESCENDING SortOrder = 2
)

func (SortOrder) Descriptor

func (SortOrder) Descriptor() protoreflect.EnumDescriptor

func (SortOrder) Enum

func (x SortOrder) Enum() *SortOrder

func (SortOrder) EnumDescriptor deprecated

func (SortOrder) EnumDescriptor() ([]byte, []int)

Deprecated: Use SortOrder.Descriptor instead.

func (SortOrder) Number

func (x SortOrder) Number() protoreflect.EnumNumber

func (SortOrder) String

func (x SortOrder) String() string

func (SortOrder) Type

type StringList

type StringList struct {

	// The string values.
	Values []string `protobuf:"bytes,1,rep,name=values,proto3" json:"values,omitempty"`
	// contains filtered or unexported fields
}

List of string values.

func (*StringList) Descriptor deprecated

func (*StringList) Descriptor() ([]byte, []int)

Deprecated: Use StringList.ProtoReflect.Descriptor instead.

func (*StringList) GetValues

func (x *StringList) GetValues() []string

func (*StringList) ProtoMessage

func (*StringList) ProtoMessage()

func (*StringList) ProtoReflect

func (x *StringList) ProtoReflect() protoreflect.Message

func (*StringList) Reset

func (x *StringList) Reset()

func (*StringList) String

func (x *StringList) String() string

type UnimplementedAdMobApiServer

type UnimplementedAdMobApiServer struct {
}

UnimplementedAdMobApiServer can be embedded to have forward compatible implementations.

func (*UnimplementedAdMobApiServer) GetPublisherAccount

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL