--- v18/services/data_link_service.proto 2024-10-16 17:56:30.000000000 +0000 +++ v19/services/data_link_service.proto 2025-02-24 15:30:13.000000000 +0000 @@ -1,83 +1,179 @@ // Copyright 2024 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.v18.services; +package google.ads.googleads.v19.services; -import "google/ads/googleads/v18/resources/data_link.proto"; +import "google/ads/googleads/v19/enums/data_link_status.proto"; +import "google/ads/googleads/v19/resources/data_link.proto"; import "google/api/annotations.proto"; import "google/api/client.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V18.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v18/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V19.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v19/services;services"; option java_multiple_files = true; option java_outer_classname = "DataLinkServiceProto"; -option java_package = "com.google.ads.googleads.v18.services"; +option java_package = "com.google.ads.googleads.v19.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V18\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V18::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V19\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V19::Services"; // This service allows management of data links between a Google // Ads customer and another data entity. service DataLinkService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; // Creates a data link. The requesting Google Ads account name and account ID // will be shared with the third party (such as YouTube creators for video // links) to whom you are creating the link with. Only customers on the // allow-list can create data links. // // List of thrown errors: // [AuthenticationError]() // [AuthorizationError]() // [DatabaseError]() // [DataLinkError]() // [FieldError]() // [HeaderError]() // [InternalError]() // [MutateError]() // [QuotaError]() // [RequestError]() rpc CreateDataLink(CreateDataLinkRequest) returns (CreateDataLinkResponse) { option (google.api.http) = { - post: "/v18/customers/{customer_id=*}/dataLinks:create" + post: "/v19/customers/{customer_id=*}/dataLinks:create" body: "*" }; option (google.api.method_signature) = "customer_id,data_link"; } + + // Remove a data link. + // + // List of thrown errors: + // [AuthenticationError]() + // [AuthorizationError]() + // [DatabaseError]() + // [DataLinkError]() + // [FieldError]() + // [HeaderError]() + // [InternalError]() + // [MutateError]() + // [QuotaError]() + // [RequestError]() + rpc RemoveDataLink(RemoveDataLinkRequest) returns (RemoveDataLinkResponse) { + option (google.api.http) = { + post: "/v19/customers/{customer_id=*}/dataLinks:remove" + body: "*" + }; + option (google.api.method_signature) = "customer_id,resource_name"; + } + + // Update a data link. + // + // List of thrown errors: + // [AuthenticationError]() + // [AuthorizationError]() + // [DatabaseError]() + // [DataLinkError]() + // [FieldError]() + // [HeaderError]() + // [InternalError]() + // [MutateError]() + // [QuotaError]() + // [RequestError]() + rpc UpdateDataLink(UpdateDataLinkRequest) returns (UpdateDataLinkResponse) { + option (google.api.http) = { + post: "/v19/customers/{customer_id=*}/dataLinks:update" + body: "*" + }; + option (google.api.method_signature) = + "customer_id,data_link_status,resource_name"; + } } // Request message for -// [DataLinkService.CreateDataLink][google.ads.googleads.v18.services.DataLinkService.CreateDataLink]. +// [DataLinkService.CreateDataLink][google.ads.googleads.v19.services.DataLinkService.CreateDataLink]. message CreateDataLinkRequest { // Required. The ID of the customer for which the data link is created. string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; // Required. The data link to be created. - google.ads.googleads.v18.resources.DataLink data_link = 2 + google.ads.googleads.v19.resources.DataLink data_link = 2 [(google.api.field_behavior) = REQUIRED]; } // Response message for -// [DataLinkService.CreateDataLink][google.ads.googleads.v18.services.DataLinkService.CreateDataLink]. +// [DataLinkService.CreateDataLink][google.ads.googleads.v19.services.DataLinkService.CreateDataLink]. message CreateDataLinkResponse { // Returned for successful operations. Resource name of the data link. string resource_name = 1 [(google.api.resource_reference) = { type: "googleads.googleapis.com/DataLink" }]; } + +// Request message for +// [DataLinkService.RemoveDataLink][google.ads.googleads.v19.services.DataLinkService.RemoveDataLink]. +message RemoveDataLinkRequest { + // Required. The ID of the customer for which the data link is updated. + string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; + + // Required. The data link is expected to have a valid resource name. + string resource_name = 2 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "googleads.googleapis.com/DataLink" + } + ]; +} + +// Response message for +// [DataLinkService.RemoveDataLink][google.ads.googleads.v19.services.DataLinkService.RemoveDataLink]. +message RemoveDataLinkResponse { + // Result for the remove request. + string resource_name = 1 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/DataLink" + }]; +} + +// Request message for +// [DataLinkService.UpdateDataLink][google.ads.googleads.v19.services.DataLinkService.UpdateDataLink]. +message UpdateDataLinkRequest { + // Required. The ID of the customer for which the data link is created. + string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; + + // Required. The data link status to be updated to. + google.ads.googleads.v19.enums.DataLinkStatusEnum.DataLinkStatus + data_link_status = 2 [(google.api.field_behavior) = REQUIRED]; + + // Required. The data link is expected to have a valid resource name. + string resource_name = 3 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "googleads.googleapis.com/DataLink" + } + ]; +} + +// Response message for +// [DataLinkService.UpdateDataLink][google.ads.googleads.v19.services.DataLinkService.UpdateDataLink]. +message UpdateDataLinkResponse { + // Returned for successful operations. Resource name of the data link. + string resource_name = 1 [(google.api.resource_reference) = { + type: "googleads.googleapis.com/DataLink" + }]; +}
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-02-24 UTC.