OAuth2 scopes used by this API.
const (
// See your AdMob data
AdmobReadonlyScope = "https://www.googleapis.com/auth/admob.readonly"
// See your AdMob data
AdmobReportScope = "https://www.googleapis.com/auth/admob.report"
)
type AccountsAdSourcesAdaptersListCall struct {
// contains filtered or unexported fields
}
func (c *AccountsAdSourcesAdaptersListCall) Context(ctx context.Context) *AccountsAdSourcesAdaptersListCall
Context sets the context to be used in this call's Do method.
func (c *AccountsAdSourcesAdaptersListCall) Do(opts ...googleapi.CallOption) (*ListAdaptersResponse, error)
Do executes the "admob.accounts.adSources.adapters.list" call. Any non-2xx status code is an error. Response headers are in either *ListAdaptersResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *AccountsAdSourcesAdaptersListCall) Fields(s ...googleapi.Field) *AccountsAdSourcesAdaptersListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *AccountsAdSourcesAdaptersListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *AccountsAdSourcesAdaptersListCall) IfNoneMatch(entityTag string) *AccountsAdSourcesAdaptersListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *AccountsAdSourcesAdaptersListCall) PageSize(pageSize int64) *AccountsAdSourcesAdaptersListCall
PageSize sets the optional parameter "pageSize": The maximum number of adapters to return. If unspecified or 0, at most 10,000 adapters will be returned. The maximum value is 20,000; values above 20,000 will be coerced to 20,000.
func (c *AccountsAdSourcesAdaptersListCall) PageToken(pageToken string) *AccountsAdSourcesAdaptersListCall
PageToken sets the optional parameter "pageToken": A page token, received from a previous `ListAdapters` call. Provide this to retrieve the subsequent page.
func (c *AccountsAdSourcesAdaptersListCall) Pages(ctx context.Context, f func(*ListAdaptersResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type AccountsAdSourcesAdaptersService struct {
// contains filtered or unexported fields
}
func NewAccountsAdSourcesAdaptersService(s *Service) *AccountsAdSourcesAdaptersService
func (r *AccountsAdSourcesAdaptersService) List(parent string) *AccountsAdSourcesAdaptersListCall
List: List the adapters of the ad source.
type AccountsAdSourcesListCall struct {
// contains filtered or unexported fields
}
func (c *AccountsAdSourcesListCall) Context(ctx context.Context) *AccountsAdSourcesListCall
Context sets the context to be used in this call's Do method.
func (c *AccountsAdSourcesListCall) Do(opts ...googleapi.CallOption) (*ListAdSourcesResponse, error)
Do executes the "admob.accounts.adSources.list" call. Any non-2xx status code is an error. Response headers are in either *ListAdSourcesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *AccountsAdSourcesListCall) Fields(s ...googleapi.Field) *AccountsAdSourcesListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *AccountsAdSourcesListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *AccountsAdSourcesListCall) IfNoneMatch(entityTag string) *AccountsAdSourcesListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *AccountsAdSourcesListCall) PageSize(pageSize int64) *AccountsAdSourcesListCall
PageSize sets the optional parameter "pageSize": The maximum number of ad sources to return. If unspecified or 0, at most 10,000 ad sources will be returned. The maximum value is 20,000; values above 10,000 will be coerced to 20,000.
func (c *AccountsAdSourcesListCall) PageToken(pageToken string) *AccountsAdSourcesListCall
PageToken sets the optional parameter "pageToken": A page token, received from a previous `ListAdSources` call. Provide this to retrieve the subsequent page.
func (c *AccountsAdSourcesListCall) Pages(ctx context.Context, f func(*ListAdSourcesResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type AccountsAdSourcesService struct {
Adapters *AccountsAdSourcesAdaptersService
// contains filtered or unexported fields
}
func NewAccountsAdSourcesService(s *Service) *AccountsAdSourcesService
func (r *AccountsAdSourcesService) List(parent string) *AccountsAdSourcesListCall
List: List the ad sources.
type AccountsAdUnitMappingsBatchCreateCall struct {
// contains filtered or unexported fields
}
func (c *AccountsAdUnitMappingsBatchCreateCall) Context(ctx context.Context) *AccountsAdUnitMappingsBatchCreateCall
Context sets the context to be used in this call's Do method.
func (c *AccountsAdUnitMappingsBatchCreateCall) Do(opts ...googleapi.CallOption) (*BatchCreateAdUnitMappingsResponse, error)
Do executes the "admob.accounts.adUnitMappings.batchCreate" call. Any non-2xx status code is an error. Response headers are in either *BatchCreateAdUnitMappingsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *AccountsAdUnitMappingsBatchCreateCall) Fields(s ...googleapi.Field) *AccountsAdUnitMappingsBatchCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *AccountsAdUnitMappingsBatchCreateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type AccountsAdUnitMappingsService struct {
// contains filtered or unexported fields
}
func NewAccountsAdUnitMappingsService(s *Service) *AccountsAdUnitMappingsService
func (r *AccountsAdUnitMappingsService) BatchCreate(parent string, batchcreateadunitmappingsrequest *BatchCreateAdUnitMappingsRequest) *AccountsAdUnitMappingsBatchCreateCall
BatchCreate: Batch create the ad unit mappings under the specific AdMob account. The maximum allowed batch size is 100. This method has limited access. If you see a 403 permission denied error, please reach out to your account manager for access.
type AccountsAdUnitsAdUnitMappingsCreateCall struct {
// contains filtered or unexported fields
}
func (c *AccountsAdUnitsAdUnitMappingsCreateCall) Context(ctx context.Context) *AccountsAdUnitsAdUnitMappingsCreateCall
Context sets the context to be used in this call's Do method.
func (c *AccountsAdUnitsAdUnitMappingsCreateCall) Do(opts ...googleapi.CallOption) (*AdUnitMapping, error)
Do executes the "admob.accounts.adUnits.adUnitMappings.create" call. Any non-2xx status code is an error. Response headers are in either *AdUnitMapping.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *AccountsAdUnitsAdUnitMappingsCreateCall) Fields(s ...googleapi.Field) *AccountsAdUnitsAdUnitMappingsCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *AccountsAdUnitsAdUnitMappingsCreateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type AccountsAdUnitsAdUnitMappingsListCall struct {
// contains filtered or unexported fields
}
func (c *AccountsAdUnitsAdUnitMappingsListCall) Context(ctx context.Context) *AccountsAdUnitsAdUnitMappingsListCall
Context sets the context to be used in this call's Do method.
func (c *AccountsAdUnitsAdUnitMappingsListCall) Do(opts ...googleapi.CallOption) (*ListAdUnitMappingsResponse, error)
Do executes the "admob.accounts.adUnits.adUnitMappings.list" call. Any non-2xx status code is an error. Response headers are in either *ListAdUnitMappingsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *AccountsAdUnitsAdUnitMappingsListCall) Fields(s ...googleapi.Field) *AccountsAdUnitsAdUnitMappingsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *AccountsAdUnitsAdUnitMappingsListCall) Filter(filter string) *AccountsAdUnitsAdUnitMappingsListCall
Filter sets the optional parameter "filter": The filter string that uses EBNF grammar syntax (https://google.aip.dev/assets/misc/ebnf-filtering.txt). Possible field to filter by is: - "DISPLAY_NAME" Possible filter function is: - `IN`: Used to filter fields that represent a singleton including "DISPLAY_NAME". The filter functions can be added together using `AND`. `OR` functionality is not supported. Example: filter: IN(DISPLAY_NAME, "Test Ad Unit Mapping 1", "Test Ad Unit Mapping 2")
func (c *AccountsAdUnitsAdUnitMappingsListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *AccountsAdUnitsAdUnitMappingsListCall) IfNoneMatch(entityTag string) *AccountsAdUnitsAdUnitMappingsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *AccountsAdUnitsAdUnitMappingsListCall) PageSize(pageSize int64) *AccountsAdUnitsAdUnitMappingsListCall
PageSize sets the optional parameter "pageSize": The maximum number of ad unit mappings to return. If unspecified or 0, at most 10,000 ad unit mappings will be returned. The maximum value is 20,000; values above 20,000 will be coerced to 20,000.
func (c *AccountsAdUnitsAdUnitMappingsListCall) PageToken(pageToken string) *AccountsAdUnitsAdUnitMappingsListCall
PageToken sets the optional parameter "pageToken": A page token, received from a previous `ListAdUnitMappings` call. Provide this to retrieve the subsequent page.
func (c *AccountsAdUnitsAdUnitMappingsListCall) Pages(ctx context.Context, f func(*ListAdUnitMappingsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type AccountsAdUnitsAdUnitMappingsService struct {
// contains filtered or unexported fields
}
func NewAccountsAdUnitsAdUnitMappingsService(s *Service) *AccountsAdUnitsAdUnitMappingsService
func (r *AccountsAdUnitsAdUnitMappingsService) Create(parent string, adunitmapping *AdUnitMapping) *AccountsAdUnitsAdUnitMappingsCreateCall
Create: Create an ad unit mapping under the specific AdMob account and ad unit. This method has limited access. If you see a 403 permission denied error, please reach out to your account manager for access.
func (r *AccountsAdUnitsAdUnitMappingsService) List(parent string) *AccountsAdUnitsAdUnitMappingsListCall
List: List ad unit mappings under the specified AdMob account and ad unit. This method has limited access. If you see a 403 permission denied error, please reach out to your account manager for access.
type AccountsAdUnitsCreateCall struct {
// contains filtered or unexported fields
}
func (c *AccountsAdUnitsCreateCall) Context(ctx context.Context) *AccountsAdUnitsCreateCall
Context sets the context to be used in this call's Do method.
func (c *AccountsAdUnitsCreateCall) Do(opts ...googleapi.CallOption) (*AdUnit, error)
Do executes the "admob.accounts.adUnits.create" call. Any non-2xx status code is an error. Response headers are in either *AdUnit.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *AccountsAdUnitsCreateCall) Fields(s ...googleapi.Field) *AccountsAdUnitsCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *AccountsAdUnitsCreateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type AccountsAdUnitsListCall struct {
// contains filtered or unexported fields
}
func (c *AccountsAdUnitsListCall) Context(ctx context.Context) *AccountsAdUnitsListCall
Context sets the context to be used in this call's Do method.
func (c *AccountsAdUnitsListCall) Do(opts ...googleapi.CallOption) (*ListAdUnitsResponse, error)
Do executes the "admob.accounts.adUnits.list" call. Any non-2xx status code is an error. Response headers are in either *ListAdUnitsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *AccountsAdUnitsListCall) Fields(s ...googleapi.Field) *AccountsAdUnitsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *AccountsAdUnitsListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *AccountsAdUnitsListCall) IfNoneMatch(entityTag string) *AccountsAdUnitsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *AccountsAdUnitsListCall) PageSize(pageSize int64) *AccountsAdUnitsListCall
PageSize sets the optional parameter "pageSize": The maximum number of ad units to return. If unspecified or 0, at most 10,000 ad units will be returned. The maximum value is 20,000; values above 20,000 will be coerced to 20,000.
func (c *AccountsAdUnitsListCall) PageToken(pageToken string) *AccountsAdUnitsListCall
PageToken sets the optional parameter "pageToken": The value returned by the last `ListAdUnitsResponse`; indicates that this is a continuation of a prior `ListAdUnits` call, and that the system should return the next page of data.
func (c *AccountsAdUnitsListCall) Pages(ctx context.Context, f func(*ListAdUnitsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type AccountsAdUnitsService struct {
AdUnitMappings *AccountsAdUnitsAdUnitMappingsService
// contains filtered or unexported fields
}
func NewAccountsAdUnitsService(s *Service) *AccountsAdUnitsService
func (r *AccountsAdUnitsService) Create(parent string, adunit *AdUnit) *AccountsAdUnitsCreateCall
Create: Creates an ad unit under the specified AdMob account. This method has limited access. If you see a 403 permission denied error, please reach out to your account manager for access.
func (r *AccountsAdUnitsService) List(parent string) *AccountsAdUnitsListCall
List: List the ad units under the specified AdMob account.
type AccountsAppsCreateCall struct {
// contains filtered or unexported fields
}
func (c *AccountsAppsCreateCall) Context(ctx context.Context) *AccountsAppsCreateCall
Context sets the context to be used in this call's Do method.
func (c *AccountsAppsCreateCall) Do(opts ...googleapi.CallOption) (*App, error)
Do executes the "admob.accounts.apps.create" call. Any non-2xx status code is an error. Response headers are in either *App.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *AccountsAppsCreateCall) Fields(s ...googleapi.Field) *AccountsAppsCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *AccountsAppsCreateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type AccountsAppsListCall struct {
// contains filtered or unexported fields
}
func (c *AccountsAppsListCall) Context(ctx context.Context) *AccountsAppsListCall
Context sets the context to be used in this call's Do method.
func (c *AccountsAppsListCall) Do(opts ...googleapi.CallOption) (*ListAppsResponse, error)
Do executes the "admob.accounts.apps.list" call. Any non-2xx status code is an error. Response headers are in either *ListAppsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *AccountsAppsListCall) Fields(s ...googleapi.Field) *AccountsAppsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *AccountsAppsListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *AccountsAppsListCall) IfNoneMatch(entityTag string) *AccountsAppsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *AccountsAppsListCall) PageSize(pageSize int64) *AccountsAppsListCall
PageSize sets the optional parameter "pageSize": The maximum number of apps to return. If unspecified or 0, at most 10,000 apps will be returned. The maximum value is 20,000; values above 20,000 will be coerced to 20,000.
func (c *AccountsAppsListCall) PageToken(pageToken string) *AccountsAppsListCall
PageToken sets the optional parameter "pageToken": The value returned by the last `ListAppsResponse`; indicates that this is a continuation of a prior `ListApps` call, and that the system should return the next page of data.
func (c *AccountsAppsListCall) Pages(ctx context.Context, f func(*ListAppsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type AccountsAppsService struct {
// contains filtered or unexported fields
}
func NewAccountsAppsService(s *Service) *AccountsAppsService
func (r *AccountsAppsService) Create(parent string, app *App) *AccountsAppsCreateCall
Create: Creates an app under the specified AdMob account. This method has limited access. If you see a 403 permission denied error, please reach out to your account manager for access.
func (r *AccountsAppsService) List(parent string) *AccountsAppsListCall
List: List the apps under the specified AdMob account.
type AccountsCampaignReportGenerateCall struct {
// contains filtered or unexported fields
}
func (c *AccountsCampaignReportGenerateCall) Context(ctx context.Context) *AccountsCampaignReportGenerateCall
Context sets the context to be used in this call's Do method.
func (c *AccountsCampaignReportGenerateCall) Do(opts ...googleapi.CallOption) (*GenerateCampaignReportResponse, error)
Do executes the "admob.accounts.campaignReport.generate" call. Any non-2xx status code is an error. Response headers are in either *GenerateCampaignReportResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *AccountsCampaignReportGenerateCall) Fields(s ...googleapi.Field) *AccountsCampaignReportGenerateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *AccountsCampaignReportGenerateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type AccountsCampaignReportService struct {
// contains filtered or unexported fields
}
func NewAccountsCampaignReportService(s *Service) *AccountsCampaignReportService
func (r *AccountsCampaignReportService) Generate(parent string, generatecampaignreportrequest *GenerateCampaignReportRequest) *AccountsCampaignReportGenerateCall
Generate: Generates Campaign Report based on provided specifications.
type AccountsGetCall struct {
// contains filtered or unexported fields
}
func (c *AccountsGetCall) Context(ctx context.Context) *AccountsGetCall
Context sets the context to be used in this call's Do method.
func (c *AccountsGetCall) Do(opts ...googleapi.CallOption) (*PublisherAccount, error)
Do executes the "admob.accounts.get" call. Any non-2xx status code is an error. Response headers are in either *PublisherAccount.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *AccountsGetCall) Fields(s ...googleapi.Field) *AccountsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *AccountsGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *AccountsGetCall) IfNoneMatch(entityTag string) *AccountsGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type AccountsListCall struct {
// contains filtered or unexported fields
}
func (c *AccountsListCall) Context(ctx context.Context) *AccountsListCall
Context sets the context to be used in this call's Do method.
func (c *AccountsListCall) Do(opts ...googleapi.CallOption) (*ListPublisherAccountsResponse, error)
Do executes the "admob.accounts.list" call. Any non-2xx status code is an error. Response headers are in either *ListPublisherAccountsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *AccountsListCall) Fields(s ...googleapi.Field) *AccountsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *AccountsListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *AccountsListCall) IfNoneMatch(entityTag string) *AccountsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *AccountsListCall) PageSize(pageSize int64) *AccountsListCall
PageSize sets the optional parameter "pageSize": Maximum number of accounts to return.
func (c *AccountsListCall) PageToken(pageToken string) *AccountsListCall
PageToken sets the optional parameter "pageToken": 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.
func (c *AccountsListCall) Pages(ctx context.Context, f func(*ListPublisherAccountsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type AccountsMediationGroupsCreateCall struct {
// contains filtered or unexported fields
}
func (c *AccountsMediationGroupsCreateCall) Context(ctx context.Context) *AccountsMediationGroupsCreateCall
Context sets the context to be used in this call's Do method.
func (c *AccountsMediationGroupsCreateCall) Do(opts ...googleapi.CallOption) (*MediationGroup, error)
Do executes the "admob.accounts.mediationGroups.create" call. Any non-2xx status code is an error. Response headers are in either *MediationGroup.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *AccountsMediationGroupsCreateCall) Fields(s ...googleapi.Field) *AccountsMediationGroupsCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *AccountsMediationGroupsCreateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type AccountsMediationGroupsListCall struct {
// contains filtered or unexported fields
}
func (c *AccountsMediationGroupsListCall) Context(ctx context.Context) *AccountsMediationGroupsListCall
Context sets the context to be used in this call's Do method.
func (c *AccountsMediationGroupsListCall) Do(opts ...googleapi.CallOption) (*ListMediationGroupsResponse, error)
Do executes the "admob.accounts.mediationGroups.list" call. Any non-2xx status code is an error. Response headers are in either *ListMediationGroupsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *AccountsMediationGroupsListCall) Fields(s ...googleapi.Field) *AccountsMediationGroupsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *AccountsMediationGroupsListCall) Filter(filter string) *AccountsMediationGroupsListCall
Filter sets the optional parameter "filter": The filter string that uses EBNF grammar syntax (https://google.aip.dev/assets/misc/ebnf-filtering.txt). Possible fields to filter by are: - "AD_SOURCE_IDS" - "AD_UNIT_IDS" - "APP_IDS" - "DISPLAY_NAME" - "FORMAT" - "MEDIATION_GROUP_ID" - "PLATFORM" - "STATE" - "TARGETED_REGION_CODES" Possible filter functions are: - `IN`: Used to filter fields that represent a singleton including "MEDIATION_GROUP_ID", "DISPLAY_NAME", "STATE", "PLATFORM", and "FORMAT". - `CONTAINS_ANY`: Used to filter fields that represent a collection including "AD_SOURCE_IDS", "AD_UNIT_IDS", "APP_IDS", and "TARGETED_REGION_CODES". The filter functions can be added together using `AND`. `OR` functionality is not supported. Example: filter: IN(DISPLAY_NAME, "Test Group 1", "Test Group 2") AND IN(PLATFORM, "ANDROID") AND CONTAINS_ANY(AD_SOURCE_IDS, "5450213213286189855")
func (c *AccountsMediationGroupsListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *AccountsMediationGroupsListCall) IfNoneMatch(entityTag string) *AccountsMediationGroupsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *AccountsMediationGroupsListCall) PageSize(pageSize int64) *AccountsMediationGroupsListCall
PageSize sets the optional parameter "pageSize": The maximum number of mediation groups to return. If unspecified or 0, at most 10,000 mediation groups will be returned. The maximum value is 20,000; values above 20,000 will be coerced to 20,000.
func (c *AccountsMediationGroupsListCall) PageToken(pageToken string) *AccountsMediationGroupsListCall
PageToken sets the optional parameter "pageToken": The value returned by the last `ListMediationGroupsResponse`; indicates that this is a continuation of a prior `ListMediationGroups` call, and that the system should return the next page of data.
func (c *AccountsMediationGroupsListCall) Pages(ctx context.Context, f func(*ListMediationGroupsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type AccountsMediationGroupsMediationAbExperimentsCreateCall struct {
// contains filtered or unexported fields
}
func (c *AccountsMediationGroupsMediationAbExperimentsCreateCall) Context(ctx context.Context) *AccountsMediationGroupsMediationAbExperimentsCreateCall
Context sets the context to be used in this call's Do method.
func (c *AccountsMediationGroupsMediationAbExperimentsCreateCall) Do(opts ...googleapi.CallOption) (*MediationAbExperiment, error)
Do executes the "admob.accounts.mediationGroups.mediationAbExperiments.create" call. Any non-2xx status code is an error. Response headers are in either *MediationAbExperiment.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *AccountsMediationGroupsMediationAbExperimentsCreateCall) Fields(s ...googleapi.Field) *AccountsMediationGroupsMediationAbExperimentsCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *AccountsMediationGroupsMediationAbExperimentsCreateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type AccountsMediationGroupsMediationAbExperimentsService struct {
// contains filtered or unexported fields
}
func NewAccountsMediationGroupsMediationAbExperimentsService(s *Service) *AccountsMediationGroupsMediationAbExperimentsService
func (r *AccountsMediationGroupsMediationAbExperimentsService) Create(parent string, mediationabexperiment *MediationAbExperiment) *AccountsMediationGroupsMediationAbExperimentsCreateCall
Create: Create an A/B testing experiment for a specified AdMob account and a mediation group. This method has limited access. If you see a 403 permission denied error, please reach out to your account manager for access.
func (r *AccountsMediationGroupsMediationAbExperimentsService) Stop(name string, stopmediationabexperimentrequest *StopMediationAbExperimentRequest) *AccountsMediationGroupsMediationAbExperimentsStopCall
Stop: Stop the mediation A/B experiment and choose a variant. This method has limited access. If you see a 403 permission denied error, please reach out to your account manager for access.
type AccountsMediationGroupsMediationAbExperimentsStopCall struct {
// contains filtered or unexported fields
}
func (c *AccountsMediationGroupsMediationAbExperimentsStopCall) Context(ctx context.Context) *AccountsMediationGroupsMediationAbExperimentsStopCall
Context sets the context to be used in this call's Do method.
func (c *AccountsMediationGroupsMediationAbExperimentsStopCall) Do(opts ...googleapi.CallOption) (*MediationAbExperiment, error)
Do executes the "admob.accounts.mediationGroups.mediationAbExperiments.stop" call. Any non-2xx status code is an error. Response headers are in either *MediationAbExperiment.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *AccountsMediationGroupsMediationAbExperimentsStopCall) Fields(s ...googleapi.Field) *AccountsMediationGroupsMediationAbExperimentsStopCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *AccountsMediationGroupsMediationAbExperimentsStopCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type AccountsMediationGroupsPatchCall struct {
// contains filtered or unexported fields
}
func (c *AccountsMediationGroupsPatchCall) Context(ctx context.Context) *AccountsMediationGroupsPatchCall
Context sets the context to be used in this call's Do method.
func (c *AccountsMediationGroupsPatchCall) Do(opts ...googleapi.CallOption) (*MediationGroup, error)
Do executes the "admob.accounts.mediationGroups.patch" call. Any non-2xx status code is an error. Response headers are in either *MediationGroup.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *AccountsMediationGroupsPatchCall) Fields(s ...googleapi.Field) *AccountsMediationGroupsPatchCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *AccountsMediationGroupsPatchCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *AccountsMediationGroupsPatchCall) UpdateMask(updateMask string) *AccountsMediationGroupsPatchCall
UpdateMask sets the optional parameter "updateMask": List of mediation group fields to be updated. Updates to repeated fields such as items in a list will fully replace the existing value(s) with the new value(s). Updates to individual values in a map can be done by indexing by the key. The following field masks are supported for mediation group updates: - "mediation_group_lines[\"{mediation_group_line_id}\"]" clang-format off - "mediation_group_lines[\"{mediation_group_line_id}\"].ad_unit_mappings[\"{ad_ unit_id}\"]" clang-format on - "mediation_group_lines[\"{mediation_group_line_id}\"].cpm_micros" - "mediation_group_lines[\"{mediation_group_line_id}\"].cpm_mode" - "mediation_group_lines[\"{mediation_group_line_id}\"].state" - "mediation_group_lines[\"{mediation_group_line_id}\"].display_name" - "targeting.ad_unit_ids" To update a mediation group with a new mediation group line, use a distinct negative number for the "mediation_group_line_id". For Example: update_mask { paths: "mediation_group_lines[\"123456789012345\"].cpm_micros" }
type AccountsMediationGroupsService struct {
MediationAbExperiments *AccountsMediationGroupsMediationAbExperimentsService
// contains filtered or unexported fields
}
func NewAccountsMediationGroupsService(s *Service) *AccountsMediationGroupsService
func (r *AccountsMediationGroupsService) Create(parent string, mediationgroup *MediationGroup) *AccountsMediationGroupsCreateCall
Create: Create a mediation group under the specific AdMob account. This method has limited access. If you see a 403 permission denied error, please reach out to your account manager for access.
func (r *AccountsMediationGroupsService) List(parent string) *AccountsMediationGroupsListCall
List: List mediation groups under the specified AdMob account. This method has limited access. If you see a 403 permission denied error, please reach out to your account manager for access.
func (r *AccountsMediationGroupsService) Patch(name string, mediationgroup *MediationGroup) *AccountsMediationGroupsPatchCall
Patch: Update the specified mediation group under the specified AdMob account. This method has limited access. If you see a 403 permission denied error, please reach out to your account manager for access.
type AccountsMediationReportGenerateCall struct {
// contains filtered or unexported fields
}
func (c *AccountsMediationReportGenerateCall) Context(ctx context.Context) *AccountsMediationReportGenerateCall
Context sets the context to be used in this call's Do method.
func (c *AccountsMediationReportGenerateCall) Do(opts ...googleapi.CallOption) (*GenerateMediationReportResponse, error)
Do executes the "admob.accounts.mediationReport.generate" call. Any non-2xx status code is an error. Response headers are in either *GenerateMediationReportResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *AccountsMediationReportGenerateCall) Fields(s ...googleapi.Field) *AccountsMediationReportGenerateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *AccountsMediationReportGenerateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type AccountsMediationReportService struct {
// contains filtered or unexported fields
}
func NewAccountsMediationReportService(s *Service) *AccountsMediationReportService
func (r *AccountsMediationReportService) Generate(parent string, generatemediationreportrequest *GenerateMediationReportRequest) *AccountsMediationReportGenerateCall
Generate: Generates an AdMob Mediation report based on the provided report specification. Returns result of a server-side streaming RPC. The result is returned in a sequence of responses.
type AccountsNetworkReportGenerateCall struct {
// contains filtered or unexported fields
}
func (c *AccountsNetworkReportGenerateCall) Context(ctx context.Context) *AccountsNetworkReportGenerateCall
Context sets the context to be used in this call's Do method.
func (c *AccountsNetworkReportGenerateCall) Do(opts ...googleapi.CallOption) (*GenerateNetworkReportResponse, error)
Do executes the "admob.accounts.networkReport.generate" call. Any non-2xx status code is an error. Response headers are in either *GenerateNetworkReportResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *AccountsNetworkReportGenerateCall) Fields(s ...googleapi.Field) *AccountsNetworkReportGenerateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *AccountsNetworkReportGenerateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type AccountsNetworkReportService struct {
// contains filtered or unexported fields
}
func NewAccountsNetworkReportService(s *Service) *AccountsNetworkReportService
func (r *AccountsNetworkReportService) Generate(parent string, generatenetworkreportrequest *GenerateNetworkReportRequest) *AccountsNetworkReportGenerateCall
Generate: Generates an AdMob Network report based on the provided report specification. Returns result of a server-side streaming RPC. The result is returned in a sequence of responses.
type AccountsService struct {
AdSources *AccountsAdSourcesService
AdUnitMappings *AccountsAdUnitMappingsService
AdUnits *AccountsAdUnitsService
Apps *AccountsAppsService
CampaignReport *AccountsCampaignReportService
MediationGroups *AccountsMediationGroupsService
MediationReport *AccountsMediationReportService
NetworkReport *AccountsNetworkReportService
// contains filtered or unexported fields
}
func NewAccountsService(s *Service) *AccountsService
func (r *AccountsService) Get(name string) *AccountsGetCall
Get: Gets information about the specified AdMob publisher account.
func (r *AccountsService) List() *AccountsListCall
List: Lists the AdMob publisher account that was most recently signed in to from the AdMob UI. For more information, see https://support.google.com/admob/answer/10243672.
AdSource: Definition of a mediation ad source.
type AdSource struct {
// AdSourceId: ID of this ad source.
AdSourceId string `json:"adSourceId,omitempty"`
// Name: Resource name of this ad source. Format is:
// accounts/{publisher_id}/adSources/{ad_source_id}
Name string `json:"name,omitempty"`
// Title: Display name of this ad source.
Title string `json:"title,omitempty"`
// ForceSendFields is a list of field names (e.g. "AdSourceId") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AdSourceId") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *AdSource) MarshalJSON() ([]byte, error)
AdUnit: Describes an AdMob ad unit.
type AdUnit struct {
// AdFormat: AdFormat of the ad unit. Possible values are as follows:
// "APP_OPEN" - App Open ad format. "BANNER" - Banner ad format.
// "BANNER_INTERSTITIAL" - Legacy format that can be used as either banner or
// interstitial. This format can no longer be created but can be targeted by
// mediation groups. "INTERSTITIAL" - A full screen ad. Supported ad types are
// "RICH_MEDIA" and "VIDEO". "NATIVE" - Native ad format. "REWARDED" - An ad
// that, once viewed, gets a callback verifying the view so that a reward can
// be given to the user. Supported ad types are "RICH_MEDIA" (interactive) and
// video where video can not be excluded. "REWARDED_INTERSTITIAL" - Rewarded
// Interstitial ad format. Only supports video ad type. See
// https://support.google.com/admob/answer/9884467.
AdFormat string `json:"adFormat,omitempty"`
// AdTypes: Ad media type supported by this ad unit. Possible values as
// follows: "RICH_MEDIA" - Text, image, and other non-video media. "VIDEO" -
// Video media.
AdTypes []string `json:"adTypes,omitempty"`
// AdUnitId: The externally visible ID of the ad unit which can be used to
// integrate with the AdMob SDK. This is a read only property. Example:
// ca-app-pub-9876543210987654/0123456789
AdUnitId string `json:"adUnitId,omitempty"`
// AppId: The externally visible ID of the app this ad unit is associated with.
// Example: ca-app-pub-9876543210987654~0123456789
AppId string `json:"appId,omitempty"`
// DisplayName: The display name of the ad unit as shown in the AdMob UI, which
// is provided by the user. The maximum length allowed is 80 characters.
DisplayName string `json:"displayName,omitempty"`
// Name: Resource name for this ad unit. Format is
// accounts/{publisher_id}/adUnits/{ad_unit_id_fragment} Example:
// accounts/pub-9876543210987654/adUnits/0123456789
Name string `json:"name,omitempty"`
// RewardSettings: Optional. Settings for a rewarded ad unit. This can be set
// or unset only when the ad_format is "REWARDED".
RewardSettings *AdUnitRewardSettings `json:"rewardSettings,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "AdFormat") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AdFormat") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *AdUnit) MarshalJSON() ([]byte, error)
AdUnitMapping: Settings to map an AdMob ad unit to a 3rd party ad unit.
type AdUnitMapping struct {
// AdUnitConfigurations: Settings for the specified ad unit to make an ad
// request to 3rd party ad network. Key-value pairs with values set by the user
// for the keys requested by the ad network. Please see
// https://support.google.com/admob/answer/3245073 for details on how to
// configure the network settings.
AdUnitConfigurations map[string]string `json:"adUnitConfigurations,omitempty"`
// AdapterId: The ID of mediation ad source adapter used by this ad unit
// mapping. The adapter determines the information needed in the
// ad_network_settings.
AdapterId int64 `json:"adapterId,omitempty,string"`
// DisplayName: Optional. The display name of this ad unit mapping instance.
DisplayName string `json:"displayName,omitempty"`
// Name: Resource name of this ad unit mapping. Format is:
// accounts/{publisher_id}/adUnits/{ad_unit_id_fragment}/adUnitMappings/{ad_unit
// _mapping_id} Example:
// accounts/pub-1234567890123456/adUnits/0123456789/adUnitMappings/987654321
Name string `json:"name,omitempty"`
// State: Output only. The status of this ad unit mapping.
//
// Possible values:
// "STATE_UNSPECIFIED" - The default value.
// "ENABLED" - The ad unit mapping is active and used to serve ads or
// collecting stats.
State string `json:"state,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "AdUnitConfigurations") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AdUnitConfigurations") to include
// in API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *AdUnitMapping) MarshalJSON() ([]byte, error)
AdUnitRewardSettings: Settings for a rewarded ad unit.
type AdUnitRewardSettings struct {
// UnitAmount: Reward amount for this ad unit.
UnitAmount int64 `json:"unitAmount,omitempty,string"`
// UnitType: Reward item for this ad unit.
UnitType string `json:"unitType,omitempty"`
// ForceSendFields is a list of field names (e.g. "UnitAmount") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "UnitAmount") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *AdUnitRewardSettings) MarshalJSON() ([]byte, error)
Adapter: Describes adapters supported by each mediation ad source. Adapters correspond to a specific SDK implementation of the ad source, and are each associated with a single platform and a list of supported ad unit formats. Adapters may also require setting some configurations to perform ad requests. Configurations can be specified in the AdUnitMapping by setting the ad_unit_configurations (#AdUnitMapping.ad_unit_configurations) key/value pairs. For example, the ad_unit_configurations can be used to pass various IDs to the adapter's third-party SDK.
type Adapter struct {
// AdapterConfigMetadata: Output only. Configuration metadata associated with
// this adapter.
AdapterConfigMetadata []*AdapterAdapterConfigMetadata `json:"adapterConfigMetadata,omitempty"`
// AdapterId: Output only. ID of this adapter. It is used to set adapter_id
// (#AdUnitMapping.adapter_id).
AdapterId string `json:"adapterId,omitempty"`
// Formats: Output only. Indicates the formats of the ad units supported by
// this adapter.
Formats []string `json:"formats,omitempty"`
// Name: Output only. Resource name of the adapter. Format is:
// accounts/{publisher_id}/adSources/{ad_source_id}/adapters/{adapter_id}.
Name string `json:"name,omitempty"`
// Platform: Output only. Mobile application platform supported by this
// adapter. Supported values are: IOS, ANDROID, WINDOWS_PHONE
Platform string `json:"platform,omitempty"`
// Title: Output only. The display name of this adapter.
Title string `json:"title,omitempty"`
// ForceSendFields is a list of field names (e.g. "AdapterConfigMetadata") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AdapterConfigMetadata") to
// include in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Adapter) MarshalJSON() ([]byte, error)
AdapterAdapterConfigMetadata: Configuration metadata associated with this adapter. They are used to define the ad_unit_configurations associated with AdUnitMappings for the this adapter.
type AdapterAdapterConfigMetadata struct {
// AdapterConfigMetadataId: This is used to fill the key of the
// ad_unit_configurations (#AdUnitMapping.ad_unit_configurations).
AdapterConfigMetadataId string `json:"adapterConfigMetadataId,omitempty"`
// AdapterConfigMetadataLabel: Name of the adapter configuration metadata.
AdapterConfigMetadataLabel string `json:"adapterConfigMetadataLabel,omitempty"`
// IsRequired: Whether this metadata is required for configuring the
// AdUnitMappings.
IsRequired bool `json:"isRequired,omitempty"`
// ForceSendFields is a list of field names (e.g. "AdapterConfigMetadataId") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AdapterConfigMetadataId") to
// include in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *AdapterAdapterConfigMetadata) MarshalJSON() ([]byte, error)
App: Describes an AdMob app for a specific platform (For example: Android or iOS).
type App struct {
// AppApprovalState: Output only. The approval state for the app. The field is
// read-only.
//
// Possible values:
// "APP_APPROVAL_STATE_UNSPECIFIED" - Default value for an unset field. Do
// not use.
// "ACTION_REQUIRED" - The app requires additional user action to be
// approved. Please refer to https://support.google.com/admob/answer/10564477
// for details and next steps.
// "IN_REVIEW" - The app is pending review.
// "APPROVED" - The app is approved and can serve ads.
AppApprovalState string `json:"appApprovalState,omitempty"`
// AppId: The externally visible ID of the app which can be used to integrate
// with the AdMob SDK. This is a read only property. Example:
// ca-app-pub-9876543210987654~0123456789
AppId string `json:"appId,omitempty"`
// LinkedAppInfo: Immutable. The information for an app that is linked to an
// app store. This field is present if and only if the app is linked to an app
// store.
LinkedAppInfo *AppLinkedAppInfo `json:"linkedAppInfo,omitempty"`
// ManualAppInfo: The information for an app that is not linked to any app
// store. After an app is linked, this information is still retrivable. If no
// name is provided for the app upon creation, a placeholder name will be used.
ManualAppInfo *AppManualAppInfo `json:"manualAppInfo,omitempty"`
// Name: Resource name for this app. Format is
// accounts/{publisher_id}/apps/{app_id_fragment} Example:
// accounts/pub-9876543210987654/apps/0123456789
Name string `json:"name,omitempty"`
// Platform: Describes the platform of the app. Limited to "IOS" and "ANDROID".
Platform string `json:"platform,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "AppApprovalState") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AppApprovalState") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *App) MarshalJSON() ([]byte, error)
AppLinkedAppInfo: Information from the app store if the app is linked to an app store.
type AppLinkedAppInfo struct {
// AndroidAppStores: Optional. The app store information for published Android
// apps. This field is only used for apps on the Android platform and will be
// ignored if the PLATFORM is set to iOS. The default value is the Google Play
// App store. This field can be updated after app is created. If the app is not
// published, this field will not be included in the response.
//
// Possible values:
// "ANDROID_APP_STORE_UNSPECIFIED" - Default value for an unset field. Do not
// use.
// "GOOGLE_PLAY_APP_STORE" - Google Play Store.
// "AMAZON_APP_STORE" - Amazon Appstore.
// "OPPO_APP_STORE" - Oppo App Market.
// "SAMSUNG_APP_STORE" - Samsung Galaxy Store.
// "VIVO_APP_STORE" - VIVO App Store.
// "XIAOMI_APP_STORE" - Xiaomi GetApps.
AndroidAppStores []string `json:"androidAppStores,omitempty"`
// AppStoreId: The app store ID of the app; present if and only if the app is
// linked to an app store. If the app is added to the Google Play store, it
// will be the application ID of the app. For example: "com.example.myapp". See
// https://developer.android.com/studio/build/application-id. If the app is
// added to the Apple App Store, it will be app store ID. For example
// "105169111". Note that setting the app store id is considered an
// irreversible action. Once an app is linked, it cannot be unlinked.
AppStoreId string `json:"appStoreId,omitempty"`
// DisplayName: Output only. Display name of the app as it appears in the app
// store. This is an output-only field, and may be empty if the app cannot be
// found in the store.
DisplayName string `json:"displayName,omitempty"`
// ForceSendFields is a list of field names (e.g. "AndroidAppStores") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AndroidAppStores") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *AppLinkedAppInfo) MarshalJSON() ([]byte, error)
AppManualAppInfo: Information provided for manual apps which are not linked to an application store (Example: Google Play, App Store).
type AppManualAppInfo struct {
// DisplayName: The display name of the app as shown in the AdMob UI, which is
// provided by the user. The maximum length allowed is 80 characters.
DisplayName string `json:"displayName,omitempty"`
// ForceSendFields is a list of field names (e.g. "DisplayName") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DisplayName") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *AppManualAppInfo) MarshalJSON() ([]byte, error)
BatchCreateAdUnitMappingsRequest: Request to create a batch of ad unit mappings under the specific AdMob account.
type BatchCreateAdUnitMappingsRequest struct {
// Requests: Required. The request message specifying the ad unit mappings to
// create. A maximum of 100 ad unit mappings can be created in a batch. If the
// number of ad unit mappings in the batch request exceed 100, the entire
// request will be rejected and no ad unit mappings will be created.
Requests []*CreateAdUnitMappingRequest `json:"requests,omitempty"`
// ForceSendFields is a list of field names (e.g. "Requests") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Requests") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *BatchCreateAdUnitMappingsRequest) MarshalJSON() ([]byte, error)
BatchCreateAdUnitMappingsResponse: Response containing a batch of created ad unit mappings.
type BatchCreateAdUnitMappingsResponse struct {
// AdUnitMappings: The Ad units mappings created under the requested account.
AdUnitMappings []*AdUnitMapping `json:"adUnitMappings,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "AdUnitMappings") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AdUnitMappings") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *BatchCreateAdUnitMappingsResponse) MarshalJSON() ([]byte, error)
CampaignReportSpec: The specification for generating a Campaign report. For example, the specification to get IMPRESSIONS and CLICKS sliced by CAMPAIGN_ID can look like the following example: { "date_range": { "start_date": {"year": 2021, "month": 12, "day": 1}, "end_date": {"year": 2021, "month": 12, "day": 30} }, "dimensions": ["CAMPAIGN_ID"], "metrics": ["IMPRESSIONS", "CLICKS"], }
type CampaignReportSpec struct {
// DateRange: The date range for which the report is generated. The max range
// is 30 days.
DateRange *DateRange `json:"dateRange,omitempty"`
// Dimensions: 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.
//
// Possible values:
// "DIMENSION_UNSPECIFIED" - Default value of an unspecified dimension. Do
// not use.
// "DATE" - A date in the YYYYMMDD format (for example, "20210701").
// "CAMPAIGN_ID" - The unique ID of the campaign, for example "123456789",
// which is consistent with the campaign id from campaign list api.
// "CAMPAIGN_NAME" - The name of the campaign.
// "AD_ID" - The unique ID of the ad, for example "123456789".
// "AD_NAME" - The name of the ad, which may not be unique.
// "PLACEMENT_ID" - The vendor-specific unique ID of the app where the ad is
// placed. For example, com.goog.bar for Android and 123456789 for iOS apps.
// "PLACEMENT_NAME" - The name of the app where the ad is placed.
// "PLACEMENT_PLATFORM" - The platform of the app where the ad is placed.
// "COUNTRY" - The name of the targeted country.
// "FORMAT" - Format of the ad unit (for example, "banner", "native"), an ad
// delivery dimension.
Dimensions []string `json:"dimensions,omitempty"`
// LanguageCode: Language used for any localized text, such as certain
// applicable dimension values. The language tag is defined in the IETF BCP47.
// Defaults to 'en-US' if unspecified or invalid.
LanguageCode string `json:"languageCode,omitempty"`
// Metrics: List of metrics of the report. A report must specify at least one
// metric.
//
// Possible values:
// "METRIC_UNSPECIFIED" - Default value for an unset field. Do not use.
// "IMPRESSIONS" - The number of times an ad is shown to the user.
// "CLICKS" - The number of times a user clicks an ad.
// "CLICK_THROUGH_RATE" - The number of clicks an ad receives divided by the
// number of times the ad is shown.
// "INSTALLS" - The number of times apps were downloaded to devices.
// "ESTIMATED_COST" - The estimated cost of serving a campaign ad instead of
// an ad that earns revenue. The currency is the reporting currency for
// campaigns.
// "AVERAGE_CPI" - The average cost per install. This means the average
// amount that was spent to acquire a new user. The currency is the reporting
// currency for campaigns.
// "INTERACTIONS" - The number of times a user interacts with an ad. This
// consists of clicks and engagements.
Metrics []string `json:"metrics,omitempty"`
// ForceSendFields is a list of field names (e.g. "DateRange") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DateRange") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *CampaignReportSpec) MarshalJSON() ([]byte, error)
CreateAdUnitMappingRequest: Request to create an ad unit mapping under the specific AdMob account and ad unit.
type CreateAdUnitMappingRequest struct {
// AdUnitMapping: Required. The ad unit mapping to create.
AdUnitMapping *AdUnitMapping `json:"adUnitMapping,omitempty"`
// Parent: Required. The parent which owns the ad unit mapping. Format:
// accounts/{publisher_id}/adUnits/{ad_unit_id}
Parent string `json:"parent,omitempty"`
// ForceSendFields is a list of field names (e.g. "AdUnitMapping") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AdUnitMapping") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *CreateAdUnitMappingRequest) MarshalJSON() ([]byte, error)
Date: Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
type Date struct {
// Day: Day of a month. Must be from 1 to 31 and valid for the year and month,
// or 0 to specify a year by itself or a year and month where the day isn't
// significant.
Day int64 `json:"day,omitempty"`
// Month: Month of a year. Must be from 1 to 12, or 0 to specify a year without
// a month and day.
Month int64 `json:"month,omitempty"`
// Year: Year of the date. Must be from 1 to 9999, or 0 to specify a date
// without a year.
Year int64 `json:"year,omitempty"`
// ForceSendFields is a list of field names (e.g. "Day") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Day") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Date) MarshalJSON() ([]byte, error)
DateRange: Specification of a single date range. Both dates are inclusive.
type DateRange struct {
// EndDate: End date of the date range, inclusive. Must be greater than or
// equal to the start date.
EndDate *Date `json:"endDate,omitempty"`
// StartDate: Start date of the date range, inclusive. Must be less than or
// equal to the end date.
StartDate *Date `json:"startDate,omitempty"`
// ForceSendFields is a list of field names (e.g. "EndDate") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "EndDate") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *DateRange) MarshalJSON() ([]byte, error)
GenerateCampaignReportRequest: Request to generate campaign report.
type GenerateCampaignReportRequest struct {
// ReportSpec: Campaign report specification.
ReportSpec *CampaignReportSpec `json:"reportSpec,omitempty"`
// ForceSendFields is a list of field names (e.g. "ReportSpec") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ReportSpec") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GenerateCampaignReportRequest) MarshalJSON() ([]byte, error)
GenerateCampaignReportResponse: Campaign Report API response.
type GenerateCampaignReportResponse struct {
// Rows: The campaign report data from the specified publisher. At most 100000
// rows will be returned from the API.
Rows []*ReportRow `json:"rows,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Rows") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Rows") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GenerateCampaignReportResponse) MarshalJSON() ([]byte, error)
GenerateMediationReportRequest: Request to generate an AdMob Mediation report.
type GenerateMediationReportRequest struct {
// ReportSpec: Network report specification.
ReportSpec *MediationReportSpec `json:"reportSpec,omitempty"`
// ForceSendFields is a list of field names (e.g. "ReportSpec") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ReportSpec") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GenerateMediationReportRequest) MarshalJSON() ([]byte, error)
GenerateMediationReportResponse: 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} }]
type GenerateMediationReportResponse struct {
// Footer: Additional information about the generated report, such as warnings
// about the data.
Footer *ReportFooter `json:"footer,omitempty"`
// Header: Report generation settings that describes the report contents, such
// as the report date range and localization settings.
Header *ReportHeader `json:"header,omitempty"`
// Row: Actual report data.
Row *ReportRow `json:"row,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Footer") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Footer") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GenerateMediationReportResponse) MarshalJSON() ([]byte, error)
GenerateNetworkReportRequest: Request to generate an AdMob Network report.
type GenerateNetworkReportRequest struct {
// ReportSpec: Network report specification.
ReportSpec *NetworkReportSpec `json:"reportSpec,omitempty"`
// ForceSendFields is a list of field names (e.g. "ReportSpec") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ReportSpec") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GenerateNetworkReportRequest) MarshalJSON() ([]byte, error)
GenerateNetworkReportResponse: 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} }]
type GenerateNetworkReportResponse struct {
// Footer: Additional information about the generated report, such as warnings
// about the data.
Footer *ReportFooter `json:"footer,omitempty"`
// Header: Report generation settings that describes the report contents, such
// as the report date range and localization settings.
Header *ReportHeader `json:"header,omitempty"`
// Row: Actual report data.
Row *ReportRow `json:"row,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Footer") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Footer") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GenerateNetworkReportResponse) MarshalJSON() ([]byte, error)
ListAdSourcesResponse: Response for the ListAdSourcesRequest.
type ListAdSourcesResponse struct {
// AdSources: The ad sources.
AdSources []*AdSource `json:"adSources,omitempty"`
// NextPageToken: Used to set the `page_token` in the `ListAdSourcesRequest` to
// retrieve the next page. If this field is omitted, there are no subsequent
// pages.
NextPageToken string `json:"nextPageToken,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "AdSources") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AdSources") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ListAdSourcesResponse) MarshalJSON() ([]byte, error)
ListAdUnitMappingsResponse: Response for the ListAdUnitMappingsRequest.
type ListAdUnitMappingsResponse struct {
// AdUnitMappings: The ad unit mappings from the specified account and ad unit.
AdUnitMappings []*AdUnitMapping `json:"adUnitMappings,omitempty"`
// NextPageToken: Used to set the `page_token` in the
// `ListAdUnitMappingsRequest` to retrieve the next page. If this field is
// omitted, there are no subsequent pages.
NextPageToken string `json:"nextPageToken,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "AdUnitMappings") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AdUnitMappings") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ListAdUnitMappingsResponse) MarshalJSON() ([]byte, error)
ListAdUnitsResponse: Response for the ad units list request.
type ListAdUnitsResponse struct {
// AdUnits: The resulting ad units for the requested account.
AdUnits []*AdUnit `json:"adUnits,omitempty"`
// NextPageToken: If not empty, indicates that there may be more ad units for
// the request; this value should be passed in a new `ListAdUnitsRequest`.
NextPageToken string `json:"nextPageToken,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "AdUnits") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AdUnits") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ListAdUnitsResponse) MarshalJSON() ([]byte, error)
ListAdaptersResponse: Response for the ListAdaptersRequest.
type ListAdaptersResponse struct {
// Adapters: The adapter.
Adapters []*Adapter `json:"adapters,omitempty"`
// NextPageToken: Used to set the `page_token` in the `ListAdapterRequest` to
// retrieve the next page. If this field is omitted, there are no subsequent
// pages.
NextPageToken string `json:"nextPageToken,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Adapters") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Adapters") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ListAdaptersResponse) MarshalJSON() ([]byte, error)
ListAppsResponse: Response for the apps list request.
type ListAppsResponse struct {
// Apps: The resulting apps for the requested account.
Apps []*App `json:"apps,omitempty"`
// NextPageToken: If not empty, indicates that there may be more apps for the
// request; this value should be passed in a new `ListAppsRequest`.
NextPageToken string `json:"nextPageToken,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Apps") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Apps") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ListAppsResponse) MarshalJSON() ([]byte, error)
ListMediationGroupsResponse: Response for the mediation groups list request.
type ListMediationGroupsResponse struct {
// MediationGroups: The resulting mediation groups for the requested account.
MediationGroups []*MediationGroup `json:"mediationGroups,omitempty"`
// NextPageToken: If not empty, indicates that there may be more mediation
// groups for the request; this value should be passed in a new
// `ListMediationGroupsRequest`.
NextPageToken string `json:"nextPageToken,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "MediationGroups") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "MediationGroups") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ListMediationGroupsResponse) MarshalJSON() ([]byte, error)
ListPublisherAccountsResponse: Response for the publisher account list request.
type ListPublisherAccountsResponse struct {
// Account: Publisher that the client credentials can access.
Account []*PublisherAccount `json:"account,omitempty"`
// NextPageToken: If not empty, indicates that there might be more accounts for
// the request; you must pass this value in a new
// `ListPublisherAccountsRequest`.
NextPageToken string `json:"nextPageToken,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Account") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Account") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ListPublisherAccountsResponse) MarshalJSON() ([]byte, error)
LocalizationSettings: Localization settings for reports, such as currency and language. It affects how metrics are calculated.
type LocalizationSettings struct {
// CurrencyCode: 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 `json:"currencyCode,omitempty"`
// LanguageCode: 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 `json:"languageCode,omitempty"`
// ForceSendFields is a list of field names (e.g. "CurrencyCode") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "CurrencyCode") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *LocalizationSettings) MarshalJSON() ([]byte, error)
MediationAbExperiment: The mediation A/B experiment.
type MediationAbExperiment struct {
// ControlMediationLines: Output only. The experiment mediation lines for
// control. They are inherited from the parent mediation group. It is an output
// only field.
ControlMediationLines []*MediationAbExperimentExperimentMediationLine `json:"controlMediationLines,omitempty"`
// DisplayName: The display name for the mediation A/B experiment.
DisplayName string `json:"displayName,omitempty"`
// EndTime: Output only. The time at which the experiment was ended or target
// to end (in UTC).
EndTime string `json:"endTime,omitempty"`
// ExperimentId: Output only. Unique identifier for the mediation A/B
// experiment. It is an output only property.
ExperimentId string `json:"experimentId,omitempty"`
// MediationGroupId: Output only. The mediation group id this experiment
// belongs to. This can be used for filtering the experiments in the list
// experiments API.
MediationGroupId string `json:"mediationGroupId,omitempty"`
// Name: Resource name for this experiment. The format is
// accounts/{publisher_id}/
// mediationGroups/{mediation_group_id}/mediationAbExperiment/
// {mediation_group_experiment_id}. For example:
// accounts/pub-9876543210987654/mediationGroups/0123456789/
// mediationAbExperiment/12345
Name string `json:"name,omitempty"`
// StartTime: Output only. The time at which the experiment was started (in
// UTC).
StartTime string `json:"startTime,omitempty"`
// State: Output only. The state of the experiment. It is an output only field.
//
// Possible values:
// "EXPERIMENT_STATE_UNSPECIFIED" - Default for an unset field. Do not use.
// "EXPIRED" - The experiment has expired.
// "RUNNING" - The experiment is running and thus used in serving.
// "ENDED" - The experiment is ended, but not yet expired. Serving continues
// in the original configurations while the experiment is ready to call an
// action.
State string `json:"state,omitempty"`
// TreatmentMediationLines: The experiment mediation lines created for the
// treatment. They will be used for serving when the experiment status is
// RUNNING.
TreatmentMediationLines []*MediationAbExperimentExperimentMediationLine `json:"treatmentMediationLines,omitempty"`
// TreatmentTrafficPercentage: The percentage of the mediation A/B experiment
// traffic that will be send to the treatment (variant B). The remainder is
// sent to the control (variant A). The percentage is expressed as an integer
// in the inclusive range of [1,99]. See
// https://support.google.com/admob/answer/9572326 for details.
TreatmentTrafficPercentage int64 `json:"treatmentTrafficPercentage,omitempty,string"`
// VariantLeader: Output only. The variant leader for the experiment according
// to some key metrics.
//
// Possible values:
// "VARIANT_LEADER_UNSPECIFIED" - Default value of the enum. Do not use.
// "CONTROL" - The control leading the experiment.
// "TREATMENT" - The treatment leading the experiment.
// "INSUFFICIENT_DATA" - Collected data (impressions) are insufficient to
// determine a leader.
// "TOO_EARLY_TO_CALL" - Experiment hasn't run long enough to determine a
// leader.
// "NO_VARIANT_LEADER" - Neither variant is a decisive winner in the observed
// data.
VariantLeader string `json:"variantLeader,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "ControlMediationLines") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ControlMediationLines") to
// include in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *MediationAbExperiment) MarshalJSON() ([]byte, error)
MediationAbExperimentExperimentMediationLine: The mediation group line for the experiment. It will be used for serving during the run of the experiment.
type MediationAbExperimentExperimentMediationLine struct {
// MediationGroupLine: The mediation group line used by the experiment.
MediationGroupLine *MediationGroupMediationGroupLine `json:"mediationGroupLine,omitempty"`
// ForceSendFields is a list of field names (e.g. "MediationGroupLine") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "MediationGroupLine") to include
// in API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *MediationAbExperimentExperimentMediationLine) MarshalJSON() ([]byte, error)
MediationGroup: Describes an AdMob Mediation group.
type MediationGroup struct {
// DisplayName: User provided name for the mediation group. The maximum length
// allowed is 120 characters.
DisplayName string `json:"displayName,omitempty"`
// MediationAbExperimentState: Output only. The state of the mediation a/b
// experiment that belongs to this mediation group.
//
// Possible values:
// "EXPERIMENT_STATE_UNSPECIFIED" - Default value for an unset field. Do not
// use.
// "RUNNING" - The mediation group has an experiment in the RUNNING state.
// "NOT_RUNNING" - There is no experiment in the RUNNING state in the
// mediation group.
MediationAbExperimentState string `json:"mediationAbExperimentState,omitempty"`
// MediationGroupId: The ID of the mediation group. Example: "0123456789". This
// is a read only property.
MediationGroupId string `json:"mediationGroupId,omitempty"`
// MediationGroupLines: The mediation lines used for serving for this mediation
// group. Key is the ID of the mediation group line. For creation, use distinct
// negative values as placeholder.
MediationGroupLines map[string]MediationGroupMediationGroupLine `json:"mediationGroupLines,omitempty"`
// Name: Resource name for this mediation group. Format is:
// accounts/{publisher_id}/mediationGroups/{mediation_group_id} Example:
// accounts/pub-9876543210987654/mediationGroups/0123456789
Name string `json:"name,omitempty"`
// State: The status of the mediation group. Only enabled mediation groups will
// be served.
//
// Possible values:
// "STATE_UNSPECIFIED" - Default value for an unset field. Do not use.
// "ENABLED" - The mediation group is active and used to serve ads or to
// collect stats.
// "DISABLED" - The mediation group has been disabled and is no longer
// serving ads or collecting stats. Disabled mediation groups can be
// re-enabled.
State string `json:"state,omitempty"`
// Targeting: Set of criteria targeted by this mediation group, such as ad
// units and geo locations.
Targeting *MediationGroupTargeting `json:"targeting,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "DisplayName") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DisplayName") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *MediationGroup) MarshalJSON() ([]byte, error)
MediationGroupMediationGroupLine: Settings for an ad network used by a mediation group.
type MediationGroupMediationGroupLine struct {
// AdSourceId: The ID of the ad source this mediation line is associated with.
AdSourceId string `json:"adSourceId,omitempty"`
// AdUnitMappings: References of the ad unit mappings for each ad unit
// associated with this mediation line. Key is the ad unit ID, value is
// resource name of the ad unit mapping. For mediation lines where the ad
// source id is the AdMob Network, ad unit mappings will be ignored.
AdUnitMappings map[string]string `json:"adUnitMappings,omitempty"`
// CpmMicros: The CPM for this allocation line. $0.01 is the minimum allowed
// amount. For LIVE CPM modes, the default amount is $0.01. This value is
// ignored if `cpm_mode` is `LIVE`. **Warning:** "USD" is the only supported
// currency at the moment. The unit is in micros.
CpmMicros int64 `json:"cpmMicros,omitempty,string"`
// CpmMode: Indicates how the CPM for this mediation line is provided. Note
// that `MANUAL` and `LIVE` are the only fully-supported mode at the moment.
// Please use the AdMob UI (https://admob.google.com) if you wish to create or
// update to other cpm modes.
//
// Possible values:
// "CPM_MODE_UNSPECIFIED" - Default value for an unset field. Do not use.
// "LIVE" - CPM is calculated per ad request based on the ad auction.
// "MANUAL" - CPM is set by the user manually.
// "ANO" - CPM is retrieved from the ad network using the publisher specified
// credentials. Output only.
CpmMode string `json:"cpmMode,omitempty"`
// DisplayName: User-provided label for this mediation line. The maximum length
// allowed is 255 characters.
DisplayName string `json:"displayName,omitempty"`
// ExperimentVariant: Output only. The Mediation A/B experiment variant to
// which the mediation group line belongs to.
//
// Possible values:
// "VARIANT_UNSPECIFIED" - Default value for an unset field. Do not use.
// "VARIANT_A" - The mediation group line belongs to the variant A.
// "VARIANT_B" - The mediation group line belongs to the variant B.
// "ORIGINAL" - The mediation group line isn't a part of an experiment.
ExperimentVariant string `json:"experimentVariant,omitempty"`
// Id: The 16 digit ID for this mediation line e.g. 0123456789012345. When
// creating a new mediation group line, use a distinct negative integer as the
// ID place holder.
Id string `json:"id,omitempty"`
// State: The status of the mediation group line. Only enabled mediation group
// lines will be served.
//
// Possible values:
// "STATE_UNSPECIFIED" - Default value for an unset field. Do not use.
// "ENABLED" - The mediation group line is active and used to serve ads.
// "DISABLED" - The mediation group line has been disabled and is no longer
// served. Disabled mediation group lines can be re-enabled.
// "REMOVED" - The mediation group line will be removed and no longer served.
// Removed mediation group lines can not be re-enabled and will no longer be
// visible. This is an input only field.
State string `json:"state,omitempty"`
// ForceSendFields is a list of field names (e.g. "AdSourceId") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AdSourceId") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *MediationGroupMediationGroupLine) MarshalJSON() ([]byte, error)
MediationGroupTargeting: Set of criteria targeted by this mediation group. For example, a mediation group can target specific ad unit IDs, platform, format and geo location.
type MediationGroupTargeting struct {
// AdUnitIds: Ad units targeted by this mediation group. Example:
// "ca-app-pub-1234/8790".
AdUnitIds []string `json:"adUnitIds,omitempty"`
// ExcludedRegionCodes: The Unicode country/region code (CLDR) of a location,
// such as "US". Unset if this mediation group does not exclude any region.
ExcludedRegionCodes []string `json:"excludedRegionCodes,omitempty"`
// Format: Ad format targeted by this mediation group. Examples: "banner",
// "native".
Format string `json:"format,omitempty"`
// IdfaTargeting: The parameter can be used to target ad requests based on the
// availability of the IDFA. If set to ALL, the mediation group applies to all
// ad requests (with or without IDFA). If set to AVAILABLE, the mediation group
// applies to ad requests with IDFA. If set to NOT_AVAILABLE, the mediation
// group applies to ad requests without IDFA. Doesn't need to be specified for
// an ANDROID device.
//
// Possible values:
// "IDFA_TARGETING_UNSPECIFIED" - Default value. This value is unused.
// "ALL" - All the devices are targeted, regardless of IDFA availability.
// "AVAILABLE" - Only the devices with IDFA availability are targeted.
// "NOT_AVAILABLE" - Only the devices without IDFA availability are targeted.
IdfaTargeting string `json:"idfaTargeting,omitempty"`
// Platform: Describes the platform of the app. Examples: "IOS", "Android".
Platform string `json:"platform,omitempty"`
// TargetedRegionCodes: The Unicode country/region code (CLDR) of a location,
// such as "US". Unset if this mediation group targets all available regions.
// For more information, see
// http://www.unicode.org/reports/tr35/#unicode_region_subtag.
TargetedRegionCodes []string `json:"targetedRegionCodes,omitempty"`
// ForceSendFields is a list of field names (e.g. "AdUnitIds") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AdUnitIds") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *MediationGroupTargeting) MarshalJSON() ([]byte, error)
MediationReportSpec: 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": 2021, "month": 9, "day": 1}, "end_date": {"year": 2021, "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 >= '2021-09-01' AND DATE <= '2021-09-30' AND COUNTRY IN ('US', 'CN') GROUP BY AD_SOURCE, APP, COUNTRY ORDER BY APP ASC;
type MediationReportSpec struct {
// DateRange: The date range for which the report is generated.
DateRange *DateRange `json:"dateRange,omitempty"`
// DimensionFilters: Describes which report rows to match based on their
// dimension values.
DimensionFilters []*MediationReportSpecDimensionFilter `json:"dimensionFilters,omitempty"`
// Dimensions: 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.
//
// Possible values:
// "DIMENSION_UNSPECIFIED" - Default value for an unset field. Do not use.
// "DATE" - A date in the YYYYMMDD format (for example, "20210701"). Requests
// can specify at most one time dimension.
// "MONTH" - A month in the YYYYMM format (for example, "202107"). Requests
// can specify at most one time dimension.
// "WEEK" - The date of the first day of a week in the YYYYMMDD format (for
// example, "20210701"). Requests can specify at most one time dimension.
// "AD_SOURCE" - The [unique ID of the ad source](/admob/api/v1/ad_sources)
// (for example, "5450213213286189855" and "AdMob Network" as label value).
// "AD_SOURCE_INSTANCE" - The unique ID of the ad source instance (for
// example, "ca-app-pub-1234:asi:5678" and "AdMob (default)" as label value).
// "AD_UNIT" - 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.
// "APP" - The unique ID of the mobile application (for example,
// "ca-app-pub-1234~1234").
// "MEDIATION_GROUP" - The unique ID of the mediation group (for example,
// "ca-app-pub-1234:mg:1234" and "AdMob (default)" as label value).
// "COUNTRY" - CLDR country code of the place where the ad views/clicks occur
// (for example, "US" or "FR"). This is a geography dimension.
// "FORMAT" - Format of the ad unit (for example, "banner", "native"), an ad
// delivery dimension.
// "PLATFORM" - Mobile OS platform of the app (for example, "Android" or
// "iOS").
// "MOBILE_OS_VERSION" - Mobile operating system version, e.g. "iOS 13.5.1".
// "GMA_SDK_VERSION" - GMA SDK version, e.g. "iOS 7.62.0".
// "APP_VERSION_NAME" - For Android, the app version name can be found in
// versionName in PackageInfo. For iOS, the app version name can be found in
// CFBundleShortVersionString.
// "SERVING_RESTRICTION" - Restriction mode for ads serving (e.g.
// "Non-personalized ads").
Dimensions []string `json:"dimensions,omitempty"`
// LocalizationSettings: Localization settings of the report.
LocalizationSettings *LocalizationSettings `json:"localizationSettings,omitempty"`
// MaxReportRows: 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. Values larger than 100000 return an error.
MaxReportRows int64 `json:"maxReportRows,omitempty"`
// Metrics: List of metrics of the report. A report must specify at least one
// metric.
//
// Possible values:
// "METRIC_UNSPECIFIED" - Default value for an unset field. Do not use.
// "AD_REQUESTS" - The number of requests. The value is an integer.
// "CLICKS" - The number of times a user clicks an ad. The value is an
// integer.
// "ESTIMATED_EARNINGS" - 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. Estimated earnings per mediation
// group and per ad source instance level is supported dating back to October
// 20, 2019. Third-party estimated earnings will show 0 for dates prior to
// October 20, 2019.
// "IMPRESSIONS" - The total number of ads shown to users. The value is an
// integer.
// "IMPRESSION_CTR" - The ratio of clicks over impressions. The value is a
// double precision (approximate) decimal value.
// "MATCHED_REQUESTS" - The number of times ads are returned in response to a
// request. The value is an integer.
// "MATCH_RATE" - The ratio of matched ad requests over the total ad
// requests. The value is a double precision (approximate) decimal value.
// "OBSERVED_ECPM" - 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. The estimated average eCPM per
// mediation group and per ad source instance level is supported dating back to
// October 20, 2019. Third-party estimated average eCPM will show 0 for dates
// prior to October 20, 2019.
Metrics []string `json:"metrics,omitempty"`
// SortConditions: 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 []*MediationReportSpecSortCondition `json:"sortConditions,omitempty"`
// TimeZone: 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 `json:"timeZone,omitempty"`
// ForceSendFields is a list of field names (e.g. "DateRange") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DateRange") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *MediationReportSpec) MarshalJSON() ([]byte, error)
MediationReportSpecDimensionFilter: Describes which report rows to match based on their dimension values.
type MediationReportSpecDimensionFilter struct {
// Dimension: Applies the filter criterion to the specified dimension.
//
// Possible values:
// "DIMENSION_UNSPECIFIED" - Default value for an unset field. Do not use.
// "DATE" - A date in the YYYYMMDD format (for example, "20210701"). Requests
// can specify at most one time dimension.
// "MONTH" - A month in the YYYYMM format (for example, "202107"). Requests
// can specify at most one time dimension.
// "WEEK" - The date of the first day of a week in the YYYYMMDD format (for
// example, "20210701"). Requests can specify at most one time dimension.
// "AD_SOURCE" - The [unique ID of the ad source](/admob/api/v1/ad_sources)
// (for example, "5450213213286189855" and "AdMob Network" as label value).
// "AD_SOURCE_INSTANCE" - The unique ID of the ad source instance (for
// example, "ca-app-pub-1234:asi:5678" and "AdMob (default)" as label value).
// "AD_UNIT" - 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.
// "APP" - The unique ID of the mobile application (for example,
// "ca-app-pub-1234~1234").
// "MEDIATION_GROUP" - The unique ID of the mediation group (for example,
// "ca-app-pub-1234:mg:1234" and "AdMob (default)" as label value).
// "COUNTRY" - CLDR country code of the place where the ad views/clicks occur
// (for example, "US" or "FR"). This is a geography dimension.
// "FORMAT" - Format of the ad unit (for example, "banner", "native"), an ad
// delivery dimension.
// "PLATFORM" - Mobile OS platform of the app (for example, "Android" or
// "iOS").
// "MOBILE_OS_VERSION" - Mobile operating system version, e.g. "iOS 13.5.1".
// "GMA_SDK_VERSION" - GMA SDK version, e.g. "iOS 7.62.0".
// "APP_VERSION_NAME" - For Android, the app version name can be found in
// versionName in PackageInfo. For iOS, the app version name can be found in
// CFBundleShortVersionString.
// "SERVING_RESTRICTION" - Restriction mode for ads serving (e.g.
// "Non-personalized ads").
Dimension string `json:"dimension,omitempty"`
// MatchesAny: Matches a row if its value for the specified dimension is in one
// of the values specified in this condition.
MatchesAny *StringList `json:"matchesAny,omitempty"`
// ForceSendFields is a list of field names (e.g. "Dimension") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Dimension") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *MediationReportSpecDimensionFilter) MarshalJSON() ([]byte, error)
MediationReportSpecSortCondition: Sorting direction to be applied on a dimension or a metric.
type MediationReportSpecSortCondition struct {
// Dimension: Sort by the specified dimension.
//
// Possible values:
// "DIMENSION_UNSPECIFIED" - Default value for an unset field. Do not use.
// "DATE" - A date in the YYYYMMDD format (for example, "20210701"). Requests
// can specify at most one time dimension.
// "MONTH" - A month in the YYYYMM format (for example, "202107"). Requests
// can specify at most one time dimension.
// "WEEK" - The date of the first day of a week in the YYYYMMDD format (for
// example, "20210701"). Requests can specify at most one time dimension.
// "AD_SOURCE" - The [unique ID of the ad source](/admob/api/v1/ad_sources)
// (for example, "5450213213286189855" and "AdMob Network" as label value).
// "AD_SOURCE_INSTANCE" - The unique ID of the ad source instance (for
// example, "ca-app-pub-1234:asi:5678" and "AdMob (default)" as label value).
// "AD_UNIT" - 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.
// "APP" - The unique ID of the mobile application (for example,
// "ca-app-pub-1234~1234").
// "MEDIATION_GROUP" - The unique ID of the mediation group (for example,
// "ca-app-pub-1234:mg:1234" and "AdMob (default)" as label value).
// "COUNTRY" - CLDR country code of the place where the ad views/clicks occur
// (for example, "US" or "FR"). This is a geography dimension.
// "FORMAT" - Format of the ad unit (for example, "banner", "native"), an ad
// delivery dimension.
// "PLATFORM" - Mobile OS platform of the app (for example, "Android" or
// "iOS").
// "MOBILE_OS_VERSION" - Mobile operating system version, e.g. "iOS 13.5.1".
// "GMA_SDK_VERSION" - GMA SDK version, e.g. "iOS 7.62.0".
// "APP_VERSION_NAME" - For Android, the app version name can be found in
// versionName in PackageInfo. For iOS, the app version name can be found in
// CFBundleShortVersionString.
// "SERVING_RESTRICTION" - Restriction mode for ads serving (e.g.
// "Non-personalized ads").
Dimension string `json:"dimension,omitempty"`
// Metric: Sort by the specified metric.
//
// Possible values:
// "METRIC_UNSPECIFIED" - Default value for an unset field. Do not use.
// "AD_REQUESTS" - The number of requests. The value is an integer.
// "CLICKS" - The number of times a user clicks an ad. The value is an
// integer.
// "ESTIMATED_EARNINGS" - 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. Estimated earnings per mediation
// group and per ad source instance level is supported dating back to October
// 20, 2019. Third-party estimated earnings will show 0 for dates prior to
// October 20, 2019.
// "IMPRESSIONS" - The total number of ads shown to users. The value is an
// integer.
// "IMPRESSION_CTR" - The ratio of clicks over impressions. The value is a
// double precision (approximate) decimal value.
// "MATCHED_REQUESTS" - The number of times ads are returned in response to a
// request. The value is an integer.
// "MATCH_RATE" - The ratio of matched ad requests over the total ad
// requests. The value is a double precision (approximate) decimal value.
// "OBSERVED_ECPM" - 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. The estimated average eCPM per
// mediation group and per ad source instance level is supported dating back to
// October 20, 2019. Third-party estimated average eCPM will show 0 for dates
// prior to October 20, 2019.
Metric string `json:"metric,omitempty"`
// Order: Sorting order of the dimension or metric.
//
// Possible values:
// "SORT_ORDER_UNSPECIFIED" - Default value for an unset field. Do not use.
// "ASCENDING" - Sort dimension value or metric value in ascending order.
// "DESCENDING" - Sort dimension value or metric value in descending order.
Order string `json:"order,omitempty"`
// ForceSendFields is a list of field names (e.g. "Dimension") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Dimension") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *MediationReportSpecSortCondition) MarshalJSON() ([]byte, error)
NetworkReportSpec: 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': 2021, 'month': 9, 'day': 1}, 'end_date': {'year': 2021, '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 >= '2021-09-01' AND DATE <= '2021-09-30' AND COUNTRY IN ('US', 'CN') GROUP BY DATE, APP, COUNTRY ORDER BY APP ASC, CLICKS DESC;
type NetworkReportSpec struct {
// DateRange: The date range for which the report is generated.
DateRange *DateRange `json:"dateRange,omitempty"`
// DimensionFilters: Describes which report rows to match based on their
// dimension values.
DimensionFilters []*NetworkReportSpecDimensionFilter `json:"dimensionFilters,omitempty"`
// Dimensions: 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.
//
// Possible values:
// "DIMENSION_UNSPECIFIED" - Default value for an unset field. Do not use.
// "DATE" - A date in the YYYYMMDD format (for example, "20210701"). Requests
// can specify at most one time dimension.
// "MONTH" - A month in the YYYYMM format (for example, "202107"). Requests
// can specify at most one time dimension.
// "WEEK" - The date of the first day of a week in the YYYYMMDD format (for
// example, "20210701"). Requests can specify at most one time dimension.
// "AD_UNIT" - 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.
// "APP" - The unique ID of the mobile application (for example,
// "ca-app-pub-1234~1234").
// "AD_TYPE" - 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.
// "COUNTRY" - CLDR country code of the place where the ad views/clicks occur
// (for example, "US" or "FR"). This is a geography dimension.
// "FORMAT" - Format of the ad unit (for example, "banner", "native"), an ad
// delivery dimension.
// "PLATFORM" - Mobile OS platform of the app (for example, "Android" or
// "iOS").
// "MOBILE_OS_VERSION" - Mobile operating system version, e.g. "iOS 13.5.1".
// "GMA_SDK_VERSION" - GMA SDK version, e.g. "iOS 7.62.0".
// "APP_VERSION_NAME" - For Android, the app version name can be found in
// versionName in PackageInfo. For iOS, the app version name can be found in
// CFBundleShortVersionString.
// "SERVING_RESTRICTION" - Restriction mode for ads serving (e.g.
// "Non-personalized ads").
Dimensions []string `json:"dimensions,omitempty"`
// LocalizationSettings: Localization settings of the report.
LocalizationSettings *LocalizationSettings `json:"localizationSettings,omitempty"`
// MaxReportRows: 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. Values larger than 100000 return an error.
MaxReportRows int64 `json:"maxReportRows,omitempty"`
// Metrics: List of metrics of the report. A report must specify at least one
// metric.
//
// Possible values:
// "METRIC_UNSPECIFIED" - Default value for an unset field. Do not use.
// "AD_REQUESTS" - The number of ad requests. The value is an integer.
// **Warning:** The metric is incompatible with
// [AD_TYPE](#Dimension.ENUM_VALUES.AD_TYPE) dimension.
// "CLICKS" - The number of times a user clicks an ad. The value is an
// integer.
// "ESTIMATED_EARNINGS" - 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.
// "IMPRESSIONS" - The total number of ads shown to users. The value is an
// integer.
// "IMPRESSION_CTR" - The ratio of clicks over impressions. The value is a
// double precision (approximate) decimal value.
// "IMPRESSION_RPM" - The estimated earnings per thousand ad impressions. The
// value is in micros. For example, $1.03 would be represented as 1030000.
// Equivalent to eCPM in the AdMob UI. **Warning:** The metric is incompatible
// with [AD_TYPE](#Dimension.ENUM_VALUES.AD_TYPE) dimension.
// "MATCHED_REQUESTS" - The number of times ads are returned in response to a
// request. The value is an integer.
// "MATCH_RATE" - 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.
// "SHOW_RATE" - 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.
Metrics []string `json:"metrics,omitempty"`
// SortConditions: 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 []*NetworkReportSpecSortCondition `json:"sortConditions,omitempty"`
// TimeZone: 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 `json:"timeZone,omitempty"`
// ForceSendFields is a list of field names (e.g. "DateRange") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DateRange") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *NetworkReportSpec) MarshalJSON() ([]byte, error)
NetworkReportSpecDimensionFilter: Describes which report rows to match based on their dimension values.
type NetworkReportSpecDimensionFilter struct {
// Dimension: Applies the filter criterion to the specified dimension.
//
// Possible values:
// "DIMENSION_UNSPECIFIED" - Default value for an unset field. Do not use.
// "DATE" - A date in the YYYYMMDD format (for example, "20210701"). Requests
// can specify at most one time dimension.
// "MONTH" - A month in the YYYYMM format (for example, "202107"). Requests
// can specify at most one time dimension.
// "WEEK" - The date of the first day of a week in the YYYYMMDD format (for
// example, "20210701"). Requests can specify at most one time dimension.
// "AD_UNIT" - 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.
// "APP" - The unique ID of the mobile application (for example,
// "ca-app-pub-1234~1234").
// "AD_TYPE" - 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.
// "COUNTRY" - CLDR country code of the place where the ad views/clicks occur
// (for example, "US" or "FR"). This is a geography dimension.
// "FORMAT" - Format of the ad unit (for example, "banner", "native"), an ad
// delivery dimension.
// "PLATFORM" - Mobile OS platform of the app (for example, "Android" or
// "iOS").
// "MOBILE_OS_VERSION" - Mobile operating system version, e.g. "iOS 13.5.1".
// "GMA_SDK_VERSION" - GMA SDK version, e.g. "iOS 7.62.0".
// "APP_VERSION_NAME" - For Android, the app version name can be found in
// versionName in PackageInfo. For iOS, the app version name can be found in
// CFBundleShortVersionString.
// "SERVING_RESTRICTION" - Restriction mode for ads serving (e.g.
// "Non-personalized ads").
Dimension string `json:"dimension,omitempty"`
// MatchesAny: Matches a row if its value for the specified dimension is in one
// of the values specified in this condition.
MatchesAny *StringList `json:"matchesAny,omitempty"`
// ForceSendFields is a list of field names (e.g. "Dimension") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Dimension") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *NetworkReportSpecDimensionFilter) MarshalJSON() ([]byte, error)
NetworkReportSpecSortCondition: Sorting direction to be applied on a dimension or a metric.
type NetworkReportSpecSortCondition struct {
// Dimension: Sort by the specified dimension.
//
// Possible values:
// "DIMENSION_UNSPECIFIED" - Default value for an unset field. Do not use.
// "DATE" - A date in the YYYYMMDD format (for example, "20210701"). Requests
// can specify at most one time dimension.
// "MONTH" - A month in the YYYYMM format (for example, "202107"). Requests
// can specify at most one time dimension.
// "WEEK" - The date of the first day of a week in the YYYYMMDD format (for
// example, "20210701"). Requests can specify at most one time dimension.
// "AD_UNIT" - 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.
// "APP" - The unique ID of the mobile application (for example,
// "ca-app-pub-1234~1234").
// "AD_TYPE" - 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.
// "COUNTRY" - CLDR country code of the place where the ad views/clicks occur
// (for example, "US" or "FR"). This is a geography dimension.
// "FORMAT" - Format of the ad unit (for example, "banner", "native"), an ad
// delivery dimension.
// "PLATFORM" - Mobile OS platform of the app (for example, "Android" or
// "iOS").
// "MOBILE_OS_VERSION" - Mobile operating system version, e.g. "iOS 13.5.1".
// "GMA_SDK_VERSION" - GMA SDK version, e.g. "iOS 7.62.0".
// "APP_VERSION_NAME" - For Android, the app version name can be found in
// versionName in PackageInfo. For iOS, the app version name can be found in
// CFBundleShortVersionString.
// "SERVING_RESTRICTION" - Restriction mode for ads serving (e.g.
// "Non-personalized ads").
Dimension string `json:"dimension,omitempty"`
// Metric: Sort by the specified metric.
//
// Possible values:
// "METRIC_UNSPECIFIED" - Default value for an unset field. Do not use.
// "AD_REQUESTS" - The number of ad requests. The value is an integer.
// **Warning:** The metric is incompatible with
// [AD_TYPE](#Dimension.ENUM_VALUES.AD_TYPE) dimension.
// "CLICKS" - The number of times a user clicks an ad. The value is an
// integer.
// "ESTIMATED_EARNINGS" - 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.
// "IMPRESSIONS" - The total number of ads shown to users. The value is an
// integer.
// "IMPRESSION_CTR" - The ratio of clicks over impressions. The value is a
// double precision (approximate) decimal value.
// "IMPRESSION_RPM" - The estimated earnings per thousand ad impressions. The
// value is in micros. For example, $1.03 would be represented as 1030000.
// Equivalent to eCPM in the AdMob UI. **Warning:** The metric is incompatible
// with [AD_TYPE](#Dimension.ENUM_VALUES.AD_TYPE) dimension.
// "MATCHED_REQUESTS" - The number of times ads are returned in response to a
// request. The value is an integer.
// "MATCH_RATE" - 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.
// "SHOW_RATE" - 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.
Metric string `json:"metric,omitempty"`
// Order: Sorting order of the dimension or metric.
//
// Possible values:
// "SORT_ORDER_UNSPECIFIED" - Default value for an unset field. Do not use.
// "ASCENDING" - Sort dimension value or metric value in ascending order.
// "DESCENDING" - Sort dimension value or metric value in descending order.
Order string `json:"order,omitempty"`
// ForceSendFields is a list of field names (e.g. "Dimension") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Dimension") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *NetworkReportSpecSortCondition) MarshalJSON() ([]byte, error)
PublisherAccount: A publisher account contains information relevant to the use of this API, such as the time zone used for the reports.
type PublisherAccount struct {
// CurrencyCode: 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 `json:"currencyCode,omitempty"`
// Name: Resource name of this account. Format is accounts/{publisher_id}.
Name string `json:"name,omitempty"`
// PublisherId: The unique ID by which this publisher account can be identified
// in the API requests (for example, pub-1234567890).
PublisherId string `json:"publisherId,omitempty"`
// ReportingTimeZone: 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 `json:"reportingTimeZone,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "CurrencyCode") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "CurrencyCode") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *PublisherAccount) MarshalJSON() ([]byte, error)
ReportFooter: Groups data available after report generation, for example, warnings and row counts. Always sent as the last message in the stream response.
type ReportFooter struct {
// MatchingRowCount: Total number of rows that matched the request. Warning:
// This count does NOT always match the number of rows in the response. Do not
// make that assumption when processing the response.
MatchingRowCount int64 `json:"matchingRowCount,omitempty,string"`
// Warnings: Warnings associated with generation of the report.
Warnings []*ReportWarning `json:"warnings,omitempty"`
// ForceSendFields is a list of field names (e.g. "MatchingRowCount") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "MatchingRowCount") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ReportFooter) MarshalJSON() ([]byte, error)
ReportHeader: Groups data helps to treat the generated report. Always sent as a first message in the stream response.
type ReportHeader struct {
// DateRange: The date range for which the report is generated. This is
// identical to the range specified in the report request.
DateRange *DateRange `json:"dateRange,omitempty"`
// LocalizationSettings: Localization settings of the report. This is identical
// to the settings in the report request.
LocalizationSettings *LocalizationSettings `json:"localizationSettings,omitempty"`
// ReportingTimeZone: The report time zone. The value is a time-zone ID as
// specified by the CLDR project, for example, "America/Los_Angeles".
ReportingTimeZone string `json:"reportingTimeZone,omitempty"`
// ForceSendFields is a list of field names (e.g. "DateRange") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DateRange") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ReportHeader) MarshalJSON() ([]byte, error)
ReportRow: A row of the returning report.
type ReportRow struct {
// DimensionValues: Map of dimension values in a row, with keys as enum name of
// the dimensions.
DimensionValues map[string]ReportRowDimensionValue `json:"dimensionValues,omitempty"`
// MetricValues: 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]ReportRowMetricValue `json:"metricValues,omitempty"`
// ForceSendFields is a list of field names (e.g. "DimensionValues") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DimensionValues") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ReportRow) MarshalJSON() ([]byte, error)
ReportRowDimensionValue: Representation of a dimension value.
type ReportRowDimensionValue struct {
// DisplayLabel: The localized string representation of the value. If
// unspecified, the display label should be derived from the value.
DisplayLabel string `json:"displayLabel,omitempty"`
// Value: Dimension value in the format specified in the report's spec
// Dimension enum.
Value string `json:"value,omitempty"`
// ForceSendFields is a list of field names (e.g. "DisplayLabel") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DisplayLabel") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ReportRowDimensionValue) MarshalJSON() ([]byte, error)
ReportRowMetricValue: Representation of a metric value.
type ReportRowMetricValue struct {
// DoubleValue: Double precision (approximate) decimal values. Rates are from 0
// to 1.
DoubleValue float64 `json:"doubleValue,omitempty"`
// IntegerValue: Metric integer value.
IntegerValue int64 `json:"integerValue,omitempty,string"`
// MicrosValue: 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 `json:"microsValue,omitempty,string"`
// ForceSendFields is a list of field names (e.g. "DoubleValue") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DoubleValue") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ReportRowMetricValue) MarshalJSON() ([]byte, error)
func (s *ReportRowMetricValue) UnmarshalJSON(data []byte) error
ReportWarning: Warnings associated with generation of the report.
type ReportWarning struct {
// Description: Describes the details of the warning message, in English.
Description string `json:"description,omitempty"`
// Type: Type of the warning.
//
// Possible values:
// "TYPE_UNSPECIFIED" - Default value for an unset field. Do not use.
// "DATA_BEFORE_ACCOUNT_TIMEZONE_CHANGE" - 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.
// "DATA_DELAYED" - 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.
// "OTHER" - Warnings that are exposed without a specific type. Useful when
// new warning types are added but the API is not changed yet.
// "REPORT_CURRENCY_NOT_ACCOUNT_CURRENCY" - 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.
Type string `json:"type,omitempty"`
// ForceSendFields is a list of field names (e.g. "Description") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Description") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ReportWarning) MarshalJSON() ([]byte, error)
type Service struct {
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
Accounts *AccountsService
// contains filtered or unexported fields
}
func New(client *http.Client) (*Service, error)
New creates a new Service. It uses the provided http.Client for requests.
Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.
func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)
NewService creates a new Service.
StopMediationAbExperimentRequest: Request to end the mediation A/B experiment and choose a winning variant.
type StopMediationAbExperimentRequest struct {
// VariantChoice: The choice for the winning variant.
//
// Possible values:
// "VARIANT_CHOICE_UNSPECIFIED" - Default value for an unset field. Do not
// use.
// "VARIANT_CHOICE_A" - Use the mediation lines from Variant A and complete
// the experiment. Variant A contains the original serving lines before the
// experiment creation.
// "VARIANT_CHOICE_B" - Use the mediation lines form Variant B and complete
// the experiment. Variant B contains the newly added serving lines.
VariantChoice string `json:"variantChoice,omitempty"`
// ForceSendFields is a list of field names (e.g. "VariantChoice") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "VariantChoice") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *StopMediationAbExperimentRequest) MarshalJSON() ([]byte, error)
StringList: List of string values.
type StringList struct {
// Values: The string values.
Values []string `json:"values,omitempty"`
// ForceSendFields is a list of field names (e.g. "Values") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Values") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *StringList) MarshalJSON() ([]byte, error)