--- v19/services/reach_plan_service.proto 2025-08-05 14:37:32.000000000 +0000 +++ v20/services/reach_plan_service.proto 2025-08-05 14:37:47.000000000 +0000 @@ -118,12 +121,37 @@ rpc GenerateReachForecast(GenerateReachForecastRequest) returns (GenerateReachForecastResponse) { option (google.api.http) = { - post: "/v19/customers/{customer_id=*}:generateReachForecast" + post: "/v20/customers/{customer_id=*}:generateReachForecast" body: "*" }; option (google.api.method_signature) = "customer_id,campaign_duration,planned_products"; } + + // Returns the list of plannable user lists with their plannable status. + // User lists may not be plannable for a number of reasons, including: + // - They are less than 10 days old. + // - They have a membership lifespan that is less than 30 days + // - They have less than 10,000 or more than 700,000 users. + // + // List of thrown errors: + // [AuthenticationError]() + // [AuthorizationError]() + // [FieldError]() + // [HeaderError]() + // [InternalError]() + // [QuotaError]() + // [RangeError]() + // [ReachPlanError]() + // [RequestError]() + rpc ListPlannableUserLists(ListPlannableUserListsRequest) + returns (ListPlannableUserListsResponse) { + option (google.api.http) = { + post: "/v20:listPlannableUserLists" + body: "*" + }; + option (google.api.method_signature) = "customer_id"; + } } // Request message for @@ -135,6 +163,10 @@ // The name of the customer being planned for. This is a user-defined value. optional string customer_reach_group = 2; + + // Optional. Additional information on the application issuing the request. + google.ads.googleads.v20.common.AdditionalApplicationInfo + reach_application_info = 3 [(google.api.field_behavior) = OPTIONAL]; } // Response message for @@ -163,8 +195,12 @@ } // Request message for -// [ReachPlanService.ListPlannableLocations][google.ads.googleads.v19.services.ReachPlanService.ListPlannableLocations]. -message ListPlannableLocationsRequest {} +// [ReachPlanService.ListPlannableLocations][google.ads.googleads.v20.services.ReachPlanService.ListPlannableLocations]. +message ListPlannableLocationsRequest { + // Optional. Additional information on the application issuing the request. + google.ads.googleads.v20.common.AdditionalApplicationInfo + reach_application_info = 1 [(google.api.field_behavior) = OPTIONAL]; +} // The list of plannable locations. message ListPlannableLocationsResponse { @@ -202,8 +238,12 @@ message ListPlannableProductsRequest { // Required. The ID of the selected location for planning. To list the // available plannable location IDs use - // [ReachPlanService.ListPlannableLocations][google.ads.googleads.v19.services.ReachPlanService.ListPlannableLocations]. + // [ReachPlanService.ListPlannableLocations][google.ads.googleads.v20.services.ReachPlanService.ListPlannableLocations]. string plannable_location_id = 2 [(google.api.field_behavior) = REQUIRED]; + + // Optional. Additional information on the application issuing the request. + google.ads.googleads.v20.common.AdditionalApplicationInfo + reach_application_info = 3 [(google.api.field_behavior) = OPTIONAL]; } // A response with all available products. @@ -227,6 +267,41 @@ PlannableTargeting plannable_targeting = 2; } +// Request message for +// [ReachPlanService.ListPlannableUserLists][google.ads.googleads.v20.services.ReachPlanService.ListPlannableUserLists] +// that lists the available user lists for a customer. +message ListPlannableUserListsRequest { + // Required. The ID of the customer. + string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; + + // The name of the customer being planned for. This is a user-defined value. + optional string customer_reach_group = 2; +} + +// A response with all available user lists with their plannable status. +message ListPlannableUserListsResponse { + // The list of user lists available for planning and related targeting + // metadata. + repeated PlannableUserList plannable_user_lists = 1; +} + +// A plannable user list. +message PlannableUserList { + // The user list ID. + google.ads.googleads.v20.common.UserListInfo user_list_info = 1; + + // The name of the user list. + string display_name = 2; + + // The user list type. + google.ads.googleads.v20.enums.UserListTypeEnum.UserListType user_list_type = + 3; + + // The plannable status of the user list. + google.ads.googleads.v20.enums.ReachPlanPlannableUserListStatusEnum + .ReachPlanPlannableUserListStatus plannable_status = 4; +} + // The targeting for which traffic metrics will be reported. message PlannableTargeting { // Allowed plannable age ranges for the product for which metrics will be @@ -327,6 +402,10 @@ // The name of the customer being planned for. This is a user-defined value. optional string customer_reach_group = 14; + + // Optional. Additional information on the application issuing the request. + google.ads.googleads.v20.common.AdditionalApplicationInfo + reach_application_info = 15 [(google.api.field_behavior) = OPTIONAL]; } // Effective frequency limit.
/services/reach_plan_service.proto
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2025-08-21 UTC。
[null,null,["最終更新日 2025-08-21 UTC。"],[],[],null,["# /services/reach_plan_service.proto\n\n```diff\n--- v19/services/reach_plan_service.proto 2025-08-05 14:37:32.000000000 +0000\n+++ v20/services/reach_plan_service.proto 2025-08-05 14:37:47.000000000 +0000\n@@ -118,12 +121,37 @@\n rpc GenerateReachForecast(GenerateReachForecastRequest)\n returns (GenerateReachForecastResponse) {\n option (google.api.http) = {\n- post: \"/v19/customers/{customer_id=*}:generateReachForecast\"\n+ post: \"/v20/customers/{customer_id=*}:generateReachForecast\"\n body: \"*\"\n };\n option (google.api.method_signature) =\n \"customer_id,campaign_duration,planned_products\";\n }\n+\n+ // Returns the list of plannable user lists with their plannable status.\n+ // User lists may not be plannable for a number of reasons, including:\n+ // - They are less than 10 days old.\n+ // - They have a membership lifespan that is less than 30 days\n+ // - They have less than 10,000 or more than 700,000 users.\n+ //\n+ // List of thrown errors:\n+ // [AuthenticationError]()\n+ // [AuthorizationError]()\n+ // [FieldError]()\n+ // [HeaderError]()\n+ // [InternalError]()\n+ // [QuotaError]()\n+ // [RangeError]()\n+ // [ReachPlanError]()\n+ // [RequestError]()\n+ rpc ListPlannableUserLists(ListPlannableUserListsRequest)\n+ returns (ListPlannableUserListsResponse) {\n+ option (google.api.http) = {\n+ post: \"/v20:listPlannableUserLists\"\n+ body: \"*\"\n+ };\n+ option (google.api.method_signature) = \"customer_id\";\n+ }\n }\n\n // Request message for\n@@ -135,6 +163,10 @@\n\n // The name of the customer being planned for. This is a user-defined value.\n optional string customer_reach_group = 2;\n+\n+ // Optional. Additional information on the application issuing the request.\n+ google.ads.googleads.v20.common.AdditionalApplicationInfo\n+ reach_application_info = 3 [(google.api.field_behavior) = OPTIONAL];\n }\n\n // Response message for\n@@ -163,8 +195,12 @@\n }\n\n // Request message for\n-// [ReachPlanService.ListPlannableLocations][google.ads.googleads.v19.services.ReachPlanService.ListPlannableLocations].\n-message ListPlannableLocationsRequest {}\n+// [ReachPlanService.ListPlannableLocations][google.ads.googleads.v20.services.ReachPlanService.ListPlannableLocations].\n+message ListPlannableLocationsRequest {\n+ // Optional. Additional information on the application issuing the request.\n+ google.ads.googleads.v20.common.AdditionalApplicationInfo\n+ reach_application_info = 1 [(google.api.field_behavior) = OPTIONAL];\n+}\n\n // The list of plannable locations.\n message ListPlannableLocationsResponse {\n@@ -202,8 +238,12 @@\n message ListPlannableProductsRequest {\n // Required. The ID of the selected location for planning. To list the\n // available plannable location IDs use\n- // [ReachPlanService.ListPlannableLocations][google.ads.googleads.v19.services.ReachPlanService.ListPlannableLocations].\n+ // [ReachPlanService.ListPlannableLocations][google.ads.googleads.v20.services.ReachPlanService.ListPlannableLocations].\n string plannable_location_id = 2 [(google.api.field_behavior) = REQUIRED];\n+\n+ // Optional. Additional information on the application issuing the request.\n+ google.ads.googleads.v20.common.AdditionalApplicationInfo\n+ reach_application_info = 3 [(google.api.field_behavior) = OPTIONAL];\n }\n\n // A response with all available products.\n@@ -227,6 +267,41 @@\n PlannableTargeting plannable_targeting = 2;\n }\n\n+// Request message for\n+// [ReachPlanService.ListPlannableUserLists][google.ads.googleads.v20.services.ReachPlanService.ListPlannableUserLists]\n+// that lists the available user lists for a customer.\n+message ListPlannableUserListsRequest {\n+ // Required. The ID of the customer.\n+ string customer_id = 1 [(google.api.field_behavior) = REQUIRED];\n+\n+ // The name of the customer being planned for. This is a user-defined value.\n+ optional string customer_reach_group = 2;\n+}\n+\n+// A response with all available user lists with their plannable status.\n+message ListPlannableUserListsResponse {\n+ // The list of user lists available for planning and related targeting\n+ // metadata.\n+ repeated PlannableUserList plannable_user_lists = 1;\n+}\n+\n+// A plannable user list.\n+message PlannableUserList {\n+ // The user list ID.\n+ google.ads.googleads.v20.common.UserListInfo user_list_info = 1;\n+\n+ // The name of the user list.\n+ string display_name = 2;\n+\n+ // The user list type.\n+ google.ads.googleads.v20.enums.UserListTypeEnum.UserListType user_list_type =\n+ 3;\n+\n+ // The plannable status of the user list.\n+ google.ads.googleads.v20.enums.ReachPlanPlannableUserListStatusEnum\n+ .ReachPlanPlannableUserListStatus plannable_status = 4;\n+}\n+\n // The targeting for which traffic metrics will be reported.\n message PlannableTargeting {\n // Allowed plannable age ranges for the product for which metrics will be\n@@ -327,6 +402,10 @@\n\n // The name of the customer being planned for. This is a user-defined value.\n optional string customer_reach_group = 14;\n+\n+ // Optional. Additional information on the application issuing the request.\n+ google.ads.googleads.v20.common.AdditionalApplicationInfo\n+ reach_application_info = 15 [(google.api.field_behavior) = OPTIONAL];\n }\n\n // Effective frequency limit.\n```"]]