aboutsummaryrefslogtreecommitdiff
path: root/google/ads/googleads/v0/services/google_ads_field_service.proto
diff options
context:
space:
mode:
Diffstat (limited to 'google/ads/googleads/v0/services/google_ads_field_service.proto')
-rw-r--r--google/ads/googleads/v0/services/google_ads_field_service.proto84
1 files changed, 84 insertions, 0 deletions
diff --git a/google/ads/googleads/v0/services/google_ads_field_service.proto b/google/ads/googleads/v0/services/google_ads_field_service.proto
new file mode 100644
index 000000000..99f8e11f3
--- /dev/null
+++ b/google/ads/googleads/v0/services/google_ads_field_service.proto
@@ -0,0 +1,84 @@
+// Copyright 2018 Google LLC.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// 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";
+
+package google.ads.googleads.v0.services;
+
+import "google/ads/googleads/v0/resources/google_ads_field.proto";
+import "google/api/annotations.proto";
+
+option csharp_namespace = "Google.Ads.GoogleAds.V0.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v0/services;services";
+option java_multiple_files = true;
+option java_outer_classname = "GoogleAdsFieldServiceProto";
+option java_package = "com.google.ads.googleads.v0.services";
+option objc_class_prefix = "GAA";
+option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Services";
+// Proto file describing the GoogleAdsFieldService
+
+// Service to fetch Google Ads API fields.
+service GoogleAdsFieldService {
+ // Returns just the requested field.
+ rpc GetGoogleAdsField(GetGoogleAdsFieldRequest) returns (google.ads.googleads.v0.resources.GoogleAdsField) {
+ option (google.api.http) = {
+ get: "/v0/{resource_name=googleAdsFields/*}"
+ };
+ }
+
+ // Returns all fields that match the search query.
+ rpc SearchGoogleAdsFields(SearchGoogleAdsFieldsRequest) returns (SearchGoogleAdsFieldsResponse) {
+ option (google.api.http) = {
+ post: "/v0/googleAdsFields:search"
+ body: "*"
+ };
+ }
+}
+
+// Request message for [GoogleAdsFieldService.GetGoogleAdsField][google.ads.googleads.v0.services.GoogleAdsFieldService.GetGoogleAdsField].
+message GetGoogleAdsFieldRequest {
+ // The resource name of the field to get.
+ string resource_name = 1;
+}
+
+// Request message for [GoogleAdsFieldService.SearchGoogleAdsFields][google.ads.googleads.v0.services.GoogleAdsFieldService.SearchGoogleAdsFields].
+message SearchGoogleAdsFieldsRequest {
+ // The query string.
+ string query = 1;
+
+ // Token of the page to retrieve. If not specified, the first page of
+ // results will be returned. Use the value obtained from `next_page_token`
+ // in the previous response in order to request the next page of results.
+ string page_token = 2;
+
+ // Number of elements to retrieve in a single page.
+ // When too large a page is requested, the server may decide to further
+ // limit the number of returned resources.
+ int32 page_size = 3;
+}
+
+// Response message for [GoogleAdsFieldService.SearchGoogleAdsFields][google.ads.googleads.v0.services.GoogleAdsFieldService.SearchGoogleAdsFields].
+message SearchGoogleAdsFieldsResponse {
+ // The list of fields that matched the query.
+ repeated google.ads.googleads.v0.resources.GoogleAdsField results = 1;
+
+ // Pagination token used to retrieve the next page of results. Pass the
+ // content of this string as the `page_token` attribute of the next request.
+ // `next_page_token` is not returned for the last page.
+ string next_page_token = 2;
+
+ // Total number of results that match the query ignoring the LIMIT clause.
+ int64 total_results_count = 3;
+}