AdMob API v1 20200601

1. Get rid of cloud package [breaking change];
2. Add AD_TYPE dimension to Network report;
3. Add time_zone to the Network and Mediation report;
4. Update the proto comments.

PiperOrigin-RevId: 314350001
This commit is contained in:
Google APIs 2020-06-02 09:54:12 -07:00 committed by Copybara-Service
parent 907754d70e
commit cb986db8ac
4 changed files with 73 additions and 32 deletions

View File

@ -18,6 +18,7 @@ proto_library(
deps = [
"//google/api:annotations_proto",
"//google/api:client_proto",
"//google/api:field_behavior_proto",
"//google/type:date_proto",
],
)
@ -26,7 +27,6 @@ proto_library_with_info(
name = "admob_proto_with_info",
deps = [
":admob_proto",
"//google/cloud:common_resources_proto",
],
)
@ -70,14 +70,14 @@ java_gapic_library(
java_gapic_test(
name = "admob_java_gapic_test_suite",
test_classes = [
"com.google.cloud.ads.admob.v1.AdMobApiClientTest",
"com.google.ads.admob.v1.AdMobApiClientTest",
],
runtime_deps = [":admob_java_gapic_test"],
)
# Open Source Packages
java_gapic_assembly_gradle_pkg(
name = "google-cloud-ads-admob-v1-java",
name = "google-ads-admob-v1-java",
deps = [
":admob_java_gapic",
":admob_java_grpc",
@ -112,7 +112,7 @@ go_gapic_library(
name = "admob_go_gapic",
srcs = [":admob_proto_with_info"],
grpc_service_config = "",
importpath = "cloud.google.com/go/ads/admob/apiv1;admob",
importpath = "google.golang.org/api/admob/v1;admob",
service_yaml = "//google/ads/admob:admob_v1.yaml",
deps = [
":admob_go_proto",
@ -123,12 +123,12 @@ go_test(
name = "admob_go_gapic_test",
srcs = [":admob_go_gapic_srcjar_test"],
embed = [":admob_go_gapic"],
importpath = "cloud.google.com/go/ads/admob/apiv1",
importpath = "google.golang.org/api/admob/v1",
)
# Open Source Packages
go_gapic_assembly_pkg(
name = "gapi-cloud-ads-admob-v1-go",
name = "gapi-ads-admob-v1-go",
deps = [
":admob_go_gapic",
":admob_go_gapic_srcjar-test.srcjar",
@ -154,6 +154,7 @@ moved_proto_library(
deps = [
"//google/api:annotations_proto",
"//google/api:client_proto",
"//google/api:field_behavior_proto",
"//google/type:date_proto",
],
)
@ -228,7 +229,7 @@ php_gapic_library(
# Open Source Packages
php_gapic_assembly_pkg(
name = "google-cloud-ads-admob-v1-php",
name = "google-ads-admob-v1-php",
deps = [
":admob_php_gapic",
":admob_php_grpc",
@ -298,7 +299,7 @@ ruby_gapic_library(
# Open Source Packages
ruby_gapic_assembly_pkg(
name = "google-cloud-ads-admob-v1-ruby",
name = "google-ads-admob-v1-ruby",
deps = [
":admob_ruby_gapic",
":admob_ruby_grpc",
@ -342,7 +343,7 @@ csharp_gapic_library(
# Open Source Packages
csharp_gapic_assembly_pkg(
name = "google-cloud-ads-admob-v1-csharp",
name = "google-ads-admob-v1-csharp",
deps = [
":admob_csharp_gapic",
":admob_csharp_grpc",

View File

@ -1,4 +1,4 @@
// Copyright 2019 Google LLC.
// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@ -11,7 +11,6 @@
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
syntax = "proto3";
@ -20,6 +19,7 @@ package google.ads.admob.v1;
import "google/ads/admob/v1/admob_resources.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
option go_package = "google.golang.org/genproto/googleapis/ads/admob/v1;admob";
option java_outer_classname = "AdMobApiProto";
@ -117,8 +117,8 @@ message GenerateMediationReportRequest {
// "header": {
// "date_range": {
// "start_date": {"year": 2018, "month": 9, "day": 1},
// "end_date": {"year": 2018, "month": 9, "day": 30}
// }
// "end_date": {"year": 2018, "month": 9, "day": 1}
// },
// "localization_settings": {
// "currency_code": "USD",
// "language_code": "en-US"
@ -178,8 +178,8 @@ message GenerateNetworkReportRequest {
// "header": {
// "dateRange": {
// "startDate": {"year": 2018, "month": 9, "day": 1},
// "endDate": {"year": 2018, "month": 9, "day": 30}
// }
// "endDate": {"year": 2018, "month": 9, "day": 1}
// },
// "localizationSettings": {
// "currencyCode": "USD",
// "languageCode": "en-US"
@ -200,9 +200,8 @@ message GenerateNetworkReportRequest {
// }
// }
// },
// ...
// {
// "footer": {"matchingRowCount": 5}
// "footer": {"matchingRowCount": 1}
// }]
message GenerateNetworkReportResponse {
// Each stream response message contains one type of payload.

View File

@ -3,17 +3,17 @@ config_schema_version: 1.0.0
# The settings of generated code in a specific language.
language_settings:
java:
package_name: com.google.cloud.ads.admob.v1
package_name: com.google.ads.admob.v1
python:
package_name: google.cloud.ads.admob_v1.gapic
package_name: google.ads.admob_v1.gapic
go:
package_name: cloud.google.com/go/ads/admob/apiv1
package_name: google.golang.org/api/admob/v1
csharp:
package_name: Google.Ads.Admob.V1
ruby:
package_name: Google::Cloud::Ads::Admob::V1
package_name: Google::Ads::Admob::V1
php:
package_name: Google\Cloud\Ads\Admob\V1
package_name: Google\Ads\Admob\V1
nodejs:
package_name: admob.v1
# A list of API interface configurations.

View File

@ -1,4 +1,4 @@
// Copyright 2019 Google LLC.
// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@ -11,7 +11,6 @@
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
syntax = "proto3";
@ -138,6 +137,15 @@ message NetworkReportSpec {
// "ca-app-pub-1234~1234").
APP = 5;
// Type of the ad (for example, "text" or "image"), an ad delivery
// dimension.
//
// **Warning:** The dimension is incompatible with
// [AD_REQUESTS](#Metric.ENUM_VALUES.AD_REQUESTS),
// [MATCH_RATE](#Metric.ENUM_VALUES.MATCH_RATE) and
// [IMPRESSION_RPM](#Metric.ENUM_VALUES.IMPRESSION_RPM) metrics.
AD_TYPE = 6;
// CLDR country code of the place where the ad views/clicks occur (for
// example, "US" or "FR"). This is a geography dimension.
COUNTRY = 7;
@ -159,6 +167,9 @@ message NetworkReportSpec {
METRIC_UNSPECIFIED = 0;
// The number of ad requests. The value is an integer.
//
// **Warning:** The metric is incompatible with
// [AD_TYPE](#Dimension.ENUM_VALUES.AD_TYPE) dimension.
AD_REQUESTS = 1;
// The number of times a user clicks an ad. The value is an integer.
@ -179,6 +190,9 @@ message NetworkReportSpec {
// The estimated earnings per thousand ad impressions. The value is in
// micros. For example, $1.03 would be represented as 1030000.
//
// **Warning:** The metric is incompatible with
// [AD_TYPE](#Dimension.ENUM_VALUES.AD_TYPE) dimension.
IMPRESSION_RPM = 6;
// The number of times ads are returned in response to a request. The value
@ -187,6 +201,9 @@ message NetworkReportSpec {
// 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.
MATCH_RATE = 8;
// The ratio of ads that are displayed over ads that are returned, defined
@ -222,6 +239,14 @@ message NetworkReportSpec {
// API returns as many rows as possible, up to 100000. Acceptable values are
// 1-100000, inclusive. Any other values are treated as 100000.
int32 max_report_rows = 7;
// 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.
string time_zone = 8;
}
// The specification for generating an AdMob Mediation report.
@ -314,8 +339,10 @@ message MediationReportSpec {
// The unique ID of the ad source instance (for example,
// "ca-app-pub-1234#5678" and "AdMob (default)" as label value).
// Warning: The dimension is incompatible with ESTIMATED_EARNINGS and
// OBSERVED_ECPM metrics.
//
// **Warning:** The dimension is incompatible with
// [ESTIMATED_EARNINGS](#Metric.ENUM_VALUES.ESTIMATED_EARNINGS) and
// [OBSERVED_ECPM](#Metric.ENUM_VALUES.OBSERVED_ECPM) metrics.
AD_SOURCE_INSTANCE = 5;
// The unique ID of the ad unit (for example, "ca-app-pub-1234/8790").
@ -328,8 +355,10 @@ message MediationReportSpec {
// The unique ID of the mediation group (for example,
// "ca-app-pub-1234:mg:1234" and "AdMob (default)" as label value).
// Warning: The dimension is incompatible with ESTIMATED_EARNINGS and
// OBSERVED_ECPM metrics.
//
// **Warning:** The dimension is incompatible with
// [ESTIMATED_EARNINGS](#Metric.ENUM_VALUES.ESTIMATED_EARNINGS) and
// [OBSERVED_ECPM](#Metric.ENUM_VALUES.OBSERVED_ECPM) metrics.
MEDIATION_GROUP = 11;
// CLDR country code of the place where the ad views/clicks occur (for
@ -362,8 +391,10 @@ message MediationReportSpec {
// EUR, or other) of the earning metrics are determined by the localization
// setting for currency. The amount is in micros. For example, $6.50 would
// be represented as 6500000.
// Warning: The metric is incompatible with AD_SOURCE_INSTANCE and
// MEDIATION_GROUP dimensions.
//
// **Warning:** The metric is incompatible with
// [AD_SOURCE_INSTANCE](#Dimension.ENUM_VALUES.AD_SOURCE_INSTANCE) and
// [MEDIATION_GROUP](#Dimension.ENUM_VALUES.MEDIATION_GROUP) dimensions.
ESTIMATED_EARNINGS = 3;
// The total number of ads shown to users. The value is an integer.
@ -385,8 +416,10 @@ message MediationReportSpec {
// (USD, EUR, or other) of the earning metrics are determined by the
// localization setting for currency. The amount is in micros. For example,
// $2.30 would be represented as 2300000.
// Warning: The metric is incompatible with AD_SOURCE_INSTANCE and
// MEDIATION_GROUP dimensions.
//
// **Warning:** The metric is incompatible with
// [AD_SOURCE_INSTANCE](#Dimension.ENUM_VALUES.AD_SOURCE_INSTANCE) and
// [MEDIATION_GROUP](#Dimension.ENUM_VALUES.MEDIATION_GROUP) dimensions.
OBSERVED_ECPM = 8;
}
@ -417,6 +450,14 @@ message MediationReportSpec {
// API returns as many rows as possible, up to 100000. Acceptable values are
// 1-100000, inclusive. Any other values are treated as 100000.
int32 max_report_rows = 7;
// 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.
string time_zone = 8;
}
// A row of the returning report.