analytics_admin.proto 87 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333
  1. // Copyright 2022 Google LLC
  2. //
  3. // Licensed under the Apache License, Version 2.0 (the "License");
  4. // you may not use this file except in compliance with the License.
  5. // You may obtain a copy of the License at
  6. //
  7. // http://www.apache.org/licenses/LICENSE-2.0
  8. //
  9. // Unless required by applicable law or agreed to in writing, software
  10. // distributed under the License is distributed on an "AS IS" BASIS,
  11. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. // See the License for the specific language governing permissions and
  13. // limitations under the License.
  14. syntax = "proto3";
  15. package google.analytics.admin.v1alpha;
  16. import "google/analytics/admin/v1alpha/access_report.proto";
  17. import "google/analytics/admin/v1alpha/audience.proto";
  18. import "google/analytics/admin/v1alpha/resources.proto";
  19. import "google/api/annotations.proto";
  20. import "google/api/client.proto";
  21. import "google/api/field_behavior.proto";
  22. import "google/api/resource.proto";
  23. import "google/protobuf/empty.proto";
  24. import "google/protobuf/field_mask.proto";
  25. import "google/protobuf/timestamp.proto";
  26. option go_package = "google.golang.org/genproto/googleapis/analytics/admin/v1alpha;admin";
  27. option java_multiple_files = true;
  28. option java_outer_classname = "AnalyticsAdminProto";
  29. option java_package = "com.google.analytics.admin.v1alpha";
  30. // Service Interface for the Analytics Admin API (GA4).
  31. service AnalyticsAdminService {
  32. option (google.api.default_host) = "analyticsadmin.googleapis.com";
  33. option (google.api.oauth_scopes) =
  34. "https://www.googleapis.com/auth/analytics.edit,"
  35. "https://www.googleapis.com/auth/analytics.manage.users,"
  36. "https://www.googleapis.com/auth/analytics.manage.users.readonly,"
  37. "https://www.googleapis.com/auth/analytics.readonly";
  38. // Lookup for a single Account.
  39. rpc GetAccount(GetAccountRequest) returns (Account) {
  40. option (google.api.http) = {
  41. get: "/v1alpha/{name=accounts/*}"
  42. };
  43. option (google.api.method_signature) = "name";
  44. }
  45. // Returns all accounts accessible by the caller.
  46. //
  47. // Note that these accounts might not currently have GA4 properties.
  48. // Soft-deleted (ie: "trashed") accounts are excluded by default.
  49. // Returns an empty list if no relevant accounts are found.
  50. rpc ListAccounts(ListAccountsRequest) returns (ListAccountsResponse) {
  51. option (google.api.http) = {
  52. get: "/v1alpha/accounts"
  53. };
  54. }
  55. // Marks target Account as soft-deleted (ie: "trashed") and returns it.
  56. //
  57. // This API does not have a method to restore soft-deleted accounts.
  58. // However, they can be restored using the Trash Can UI.
  59. //
  60. // If the accounts are not restored before the expiration time, the account
  61. // and all child resources (eg: Properties, GoogleAdsLinks, Streams,
  62. // UserLinks) will be permanently purged.
  63. // https://support.google.com/analytics/answer/6154772
  64. //
  65. // Returns an error if the target is not found.
  66. rpc DeleteAccount(DeleteAccountRequest) returns (google.protobuf.Empty) {
  67. option (google.api.http) = {
  68. delete: "/v1alpha/{name=accounts/*}"
  69. };
  70. option (google.api.method_signature) = "name";
  71. }
  72. // Updates an account.
  73. rpc UpdateAccount(UpdateAccountRequest) returns (Account) {
  74. option (google.api.http) = {
  75. patch: "/v1alpha/{account.name=accounts/*}"
  76. body: "account"
  77. };
  78. option (google.api.method_signature) = "account,update_mask";
  79. }
  80. // Requests a ticket for creating an account.
  81. rpc ProvisionAccountTicket(ProvisionAccountTicketRequest) returns (ProvisionAccountTicketResponse) {
  82. option (google.api.http) = {
  83. post: "/v1alpha/accounts:provisionAccountTicket"
  84. body: "*"
  85. };
  86. }
  87. // Returns summaries of all accounts accessible by the caller.
  88. rpc ListAccountSummaries(ListAccountSummariesRequest) returns (ListAccountSummariesResponse) {
  89. option (google.api.http) = {
  90. get: "/v1alpha/accountSummaries"
  91. };
  92. }
  93. // Lookup for a single "GA4" Property.
  94. rpc GetProperty(GetPropertyRequest) returns (Property) {
  95. option (google.api.http) = {
  96. get: "/v1alpha/{name=properties/*}"
  97. };
  98. option (google.api.method_signature) = "name";
  99. }
  100. // Returns child Properties under the specified parent Account.
  101. //
  102. // Only "GA4" properties will be returned.
  103. // Properties will be excluded if the caller does not have access.
  104. // Soft-deleted (ie: "trashed") properties are excluded by default.
  105. // Returns an empty list if no relevant properties are found.
  106. rpc ListProperties(ListPropertiesRequest) returns (ListPropertiesResponse) {
  107. option (google.api.http) = {
  108. get: "/v1alpha/properties"
  109. };
  110. }
  111. // Creates an "GA4" property with the specified location and attributes.
  112. rpc CreateProperty(CreatePropertyRequest) returns (Property) {
  113. option (google.api.http) = {
  114. post: "/v1alpha/properties"
  115. body: "property"
  116. };
  117. option (google.api.method_signature) = "property";
  118. }
  119. // Marks target Property as soft-deleted (ie: "trashed") and returns it.
  120. //
  121. // This API does not have a method to restore soft-deleted properties.
  122. // However, they can be restored using the Trash Can UI.
  123. //
  124. // If the properties are not restored before the expiration time, the Property
  125. // and all child resources (eg: GoogleAdsLinks, Streams, UserLinks)
  126. // will be permanently purged.
  127. // https://support.google.com/analytics/answer/6154772
  128. //
  129. // Returns an error if the target is not found, or is not an GA4 Property.
  130. rpc DeleteProperty(DeletePropertyRequest) returns (Property) {
  131. option (google.api.http) = {
  132. delete: "/v1alpha/{name=properties/*}"
  133. };
  134. option (google.api.method_signature) = "name";
  135. }
  136. // Updates a property.
  137. rpc UpdateProperty(UpdatePropertyRequest) returns (Property) {
  138. option (google.api.http) = {
  139. patch: "/v1alpha/{property.name=properties/*}"
  140. body: "property"
  141. };
  142. option (google.api.method_signature) = "property,update_mask";
  143. }
  144. // Gets information about a user's link to an account or property.
  145. rpc GetUserLink(GetUserLinkRequest) returns (UserLink) {
  146. option (google.api.http) = {
  147. get: "/v1alpha/{name=accounts/*/userLinks/*}"
  148. additional_bindings {
  149. get: "/v1alpha/{name=properties/*/userLinks/*}"
  150. }
  151. };
  152. option (google.api.method_signature) = "name";
  153. }
  154. // Gets information about multiple users' links to an account or property.
  155. rpc BatchGetUserLinks(BatchGetUserLinksRequest) returns (BatchGetUserLinksResponse) {
  156. option (google.api.http) = {
  157. get: "/v1alpha/{parent=accounts/*}/userLinks:batchGet"
  158. additional_bindings {
  159. get: "/v1alpha/{parent=properties/*}/userLinks:batchGet"
  160. }
  161. };
  162. }
  163. // Lists all user links on an account or property.
  164. rpc ListUserLinks(ListUserLinksRequest) returns (ListUserLinksResponse) {
  165. option (google.api.http) = {
  166. get: "/v1alpha/{parent=accounts/*}/userLinks"
  167. additional_bindings {
  168. get: "/v1alpha/{parent=properties/*}/userLinks"
  169. }
  170. };
  171. option (google.api.method_signature) = "parent";
  172. }
  173. // Lists all user links on an account or property, including implicit ones
  174. // that come from effective permissions granted by groups or organization
  175. // admin roles.
  176. //
  177. // If a returned user link does not have direct permissions, they cannot
  178. // be removed from the account or property directly with the DeleteUserLink
  179. // command. They have to be removed from the group/etc that gives them
  180. // permissions, which is currently only usable/discoverable in the GA or GMP
  181. // UIs.
  182. rpc AuditUserLinks(AuditUserLinksRequest) returns (AuditUserLinksResponse) {
  183. option (google.api.http) = {
  184. post: "/v1alpha/{parent=accounts/*}/userLinks:audit"
  185. body: "*"
  186. additional_bindings {
  187. post: "/v1alpha/{parent=properties/*}/userLinks:audit"
  188. body: "*"
  189. }
  190. };
  191. }
  192. // Creates a user link on an account or property.
  193. //
  194. // If the user with the specified email already has permissions on the
  195. // account or property, then the user's existing permissions will be unioned
  196. // with the permissions specified in the new UserLink.
  197. rpc CreateUserLink(CreateUserLinkRequest) returns (UserLink) {
  198. option (google.api.http) = {
  199. post: "/v1alpha/{parent=accounts/*}/userLinks"
  200. body: "user_link"
  201. additional_bindings {
  202. post: "/v1alpha/{parent=properties/*}/userLinks"
  203. body: "user_link"
  204. }
  205. };
  206. option (google.api.method_signature) = "parent,user_link";
  207. }
  208. // Creates information about multiple users' links to an account or property.
  209. //
  210. // This method is transactional. If any UserLink cannot be created, none of
  211. // the UserLinks will be created.
  212. rpc BatchCreateUserLinks(BatchCreateUserLinksRequest) returns (BatchCreateUserLinksResponse) {
  213. option (google.api.http) = {
  214. post: "/v1alpha/{parent=accounts/*}/userLinks:batchCreate"
  215. body: "*"
  216. additional_bindings {
  217. post: "/v1alpha/{parent=properties/*}/userLinks:batchCreate"
  218. body: "*"
  219. }
  220. };
  221. }
  222. // Updates a user link on an account or property.
  223. rpc UpdateUserLink(UpdateUserLinkRequest) returns (UserLink) {
  224. option (google.api.http) = {
  225. patch: "/v1alpha/{user_link.name=accounts/*/userLinks/*}"
  226. body: "user_link"
  227. additional_bindings {
  228. patch: "/v1alpha/{user_link.name=properties/*/userLinks/*}"
  229. body: "user_link"
  230. }
  231. };
  232. option (google.api.method_signature) = "user_link";
  233. }
  234. // Updates information about multiple users' links to an account or property.
  235. rpc BatchUpdateUserLinks(BatchUpdateUserLinksRequest) returns (BatchUpdateUserLinksResponse) {
  236. option (google.api.http) = {
  237. post: "/v1alpha/{parent=accounts/*}/userLinks:batchUpdate"
  238. body: "*"
  239. additional_bindings {
  240. post: "/v1alpha/{parent=properties/*}/userLinks:batchUpdate"
  241. body: "*"
  242. }
  243. };
  244. }
  245. // Deletes a user link on an account or property.
  246. rpc DeleteUserLink(DeleteUserLinkRequest) returns (google.protobuf.Empty) {
  247. option (google.api.http) = {
  248. delete: "/v1alpha/{name=accounts/*/userLinks/*}"
  249. additional_bindings {
  250. delete: "/v1alpha/{name=properties/*/userLinks/*}"
  251. }
  252. };
  253. option (google.api.method_signature) = "name";
  254. }
  255. // Deletes information about multiple users' links to an account or property.
  256. rpc BatchDeleteUserLinks(BatchDeleteUserLinksRequest) returns (google.protobuf.Empty) {
  257. option (google.api.http) = {
  258. post: "/v1alpha/{parent=accounts/*}/userLinks:batchDelete"
  259. body: "*"
  260. additional_bindings {
  261. post: "/v1alpha/{parent=properties/*}/userLinks:batchDelete"
  262. body: "*"
  263. }
  264. };
  265. }
  266. // Creates a FirebaseLink.
  267. //
  268. // Properties can have at most one FirebaseLink.
  269. rpc CreateFirebaseLink(CreateFirebaseLinkRequest) returns (FirebaseLink) {
  270. option (google.api.http) = {
  271. post: "/v1alpha/{parent=properties/*}/firebaseLinks"
  272. body: "firebase_link"
  273. };
  274. option (google.api.method_signature) = "parent,firebase_link";
  275. }
  276. // Deletes a FirebaseLink on a property
  277. rpc DeleteFirebaseLink(DeleteFirebaseLinkRequest) returns (google.protobuf.Empty) {
  278. option (google.api.http) = {
  279. delete: "/v1alpha/{name=properties/*/firebaseLinks/*}"
  280. };
  281. option (google.api.method_signature) = "name";
  282. }
  283. // Lists FirebaseLinks on a property.
  284. // Properties can have at most one FirebaseLink.
  285. rpc ListFirebaseLinks(ListFirebaseLinksRequest) returns (ListFirebaseLinksResponse) {
  286. option (google.api.http) = {
  287. get: "/v1alpha/{parent=properties/*}/firebaseLinks"
  288. };
  289. option (google.api.method_signature) = "parent";
  290. }
  291. // Returns the Site Tag for the specified web stream.
  292. // Site Tags are immutable singletons.
  293. rpc GetGlobalSiteTag(GetGlobalSiteTagRequest) returns (GlobalSiteTag) {
  294. option (google.api.http) = {
  295. get: "/v1alpha/{name=properties/*/dataStreams/*/globalSiteTag}"
  296. };
  297. option (google.api.method_signature) = "name";
  298. }
  299. // Creates a GoogleAdsLink.
  300. rpc CreateGoogleAdsLink(CreateGoogleAdsLinkRequest) returns (GoogleAdsLink) {
  301. option (google.api.http) = {
  302. post: "/v1alpha/{parent=properties/*}/googleAdsLinks"
  303. body: "google_ads_link"
  304. };
  305. option (google.api.method_signature) = "parent,google_ads_link";
  306. }
  307. // Updates a GoogleAdsLink on a property
  308. rpc UpdateGoogleAdsLink(UpdateGoogleAdsLinkRequest) returns (GoogleAdsLink) {
  309. option (google.api.http) = {
  310. patch: "/v1alpha/{google_ads_link.name=properties/*/googleAdsLinks/*}"
  311. body: "google_ads_link"
  312. };
  313. option (google.api.method_signature) = "google_ads_link,update_mask";
  314. }
  315. // Deletes a GoogleAdsLink on a property
  316. rpc DeleteGoogleAdsLink(DeleteGoogleAdsLinkRequest) returns (google.protobuf.Empty) {
  317. option (google.api.http) = {
  318. delete: "/v1alpha/{name=properties/*/googleAdsLinks/*}"
  319. };
  320. option (google.api.method_signature) = "name";
  321. }
  322. // Lists GoogleAdsLinks on a property.
  323. rpc ListGoogleAdsLinks(ListGoogleAdsLinksRequest) returns (ListGoogleAdsLinksResponse) {
  324. option (google.api.http) = {
  325. get: "/v1alpha/{parent=properties/*}/googleAdsLinks"
  326. };
  327. option (google.api.method_signature) = "parent";
  328. }
  329. // Get data sharing settings on an account.
  330. // Data sharing settings are singletons.
  331. rpc GetDataSharingSettings(GetDataSharingSettingsRequest) returns (DataSharingSettings) {
  332. option (google.api.http) = {
  333. get: "/v1alpha/{name=accounts/*/dataSharingSettings}"
  334. };
  335. option (google.api.method_signature) = "name";
  336. }
  337. // Lookup for a single "GA4" MeasurementProtocolSecret.
  338. rpc GetMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest) returns (MeasurementProtocolSecret) {
  339. option (google.api.http) = {
  340. get: "/v1alpha/{name=properties/*/dataStreams/*/measurementProtocolSecrets/*}"
  341. };
  342. option (google.api.method_signature) = "name";
  343. }
  344. // Returns child MeasurementProtocolSecrets under the specified parent
  345. // Property.
  346. rpc ListMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest) returns (ListMeasurementProtocolSecretsResponse) {
  347. option (google.api.http) = {
  348. get: "/v1alpha/{parent=properties/*/dataStreams/*}/measurementProtocolSecrets"
  349. };
  350. option (google.api.method_signature) = "parent";
  351. }
  352. // Creates a measurement protocol secret.
  353. rpc CreateMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest) returns (MeasurementProtocolSecret) {
  354. option (google.api.http) = {
  355. post: "/v1alpha/{parent=properties/*/dataStreams/*}/measurementProtocolSecrets"
  356. body: "measurement_protocol_secret"
  357. };
  358. option (google.api.method_signature) = "parent,measurement_protocol_secret";
  359. }
  360. // Deletes target MeasurementProtocolSecret.
  361. rpc DeleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest) returns (google.protobuf.Empty) {
  362. option (google.api.http) = {
  363. delete: "/v1alpha/{name=properties/*/dataStreams/*/measurementProtocolSecrets/*}"
  364. };
  365. option (google.api.method_signature) = "name";
  366. }
  367. // Updates a measurement protocol secret.
  368. rpc UpdateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest) returns (MeasurementProtocolSecret) {
  369. option (google.api.http) = {
  370. patch: "/v1alpha/{measurement_protocol_secret.name=properties/*/dataStreams/*/measurementProtocolSecrets/*}"
  371. body: "measurement_protocol_secret"
  372. };
  373. option (google.api.method_signature) = "measurement_protocol_secret,update_mask";
  374. }
  375. // Acknowledges the terms of user data collection for the specified property.
  376. //
  377. // This acknowledgement must be completed (either in the Google Analytics UI
  378. // or via this API) before MeasurementProtocolSecret resources may be created.
  379. rpc AcknowledgeUserDataCollection(AcknowledgeUserDataCollectionRequest) returns (AcknowledgeUserDataCollectionResponse) {
  380. option (google.api.http) = {
  381. post: "/v1alpha/{property=properties/*}:acknowledgeUserDataCollection"
  382. body: "*"
  383. };
  384. }
  385. // Searches through all changes to an account or its children given the
  386. // specified set of filters.
  387. rpc SearchChangeHistoryEvents(SearchChangeHistoryEventsRequest) returns (SearchChangeHistoryEventsResponse) {
  388. option (google.api.http) = {
  389. post: "/v1alpha/{account=accounts/*}:searchChangeHistoryEvents"
  390. body: "*"
  391. };
  392. }
  393. // Lookup for Google Signals settings for a property.
  394. rpc GetGoogleSignalsSettings(GetGoogleSignalsSettingsRequest) returns (GoogleSignalsSettings) {
  395. option (google.api.http) = {
  396. get: "/v1alpha/{name=properties/*/googleSignalsSettings}"
  397. };
  398. option (google.api.method_signature) = "name";
  399. }
  400. // Updates Google Signals settings for a property.
  401. rpc UpdateGoogleSignalsSettings(UpdateGoogleSignalsSettingsRequest) returns (GoogleSignalsSettings) {
  402. option (google.api.http) = {
  403. patch: "/v1alpha/{google_signals_settings.name=properties/*/googleSignalsSettings}"
  404. body: "google_signals_settings"
  405. };
  406. option (google.api.method_signature) = "google_signals_settings,update_mask";
  407. }
  408. // Creates a conversion event with the specified attributes.
  409. rpc CreateConversionEvent(CreateConversionEventRequest) returns (ConversionEvent) {
  410. option (google.api.http) = {
  411. post: "/v1alpha/{parent=properties/*}/conversionEvents"
  412. body: "conversion_event"
  413. };
  414. option (google.api.method_signature) = "parent,conversion_event";
  415. }
  416. // Retrieve a single conversion event.
  417. rpc GetConversionEvent(GetConversionEventRequest) returns (ConversionEvent) {
  418. option (google.api.http) = {
  419. get: "/v1alpha/{name=properties/*/conversionEvents/*}"
  420. };
  421. option (google.api.method_signature) = "name";
  422. }
  423. // Deletes a conversion event in a property.
  424. rpc DeleteConversionEvent(DeleteConversionEventRequest) returns (google.protobuf.Empty) {
  425. option (google.api.http) = {
  426. delete: "/v1alpha/{name=properties/*/conversionEvents/*}"
  427. };
  428. option (google.api.method_signature) = "name";
  429. }
  430. // Returns a list of conversion events in the specified parent property.
  431. //
  432. // Returns an empty list if no conversion events are found.
  433. rpc ListConversionEvents(ListConversionEventsRequest) returns (ListConversionEventsResponse) {
  434. option (google.api.http) = {
  435. get: "/v1alpha/{parent=properties/*}/conversionEvents"
  436. };
  437. option (google.api.method_signature) = "parent";
  438. }
  439. // Look up a single DisplayVideo360AdvertiserLink
  440. rpc GetDisplayVideo360AdvertiserLink(GetDisplayVideo360AdvertiserLinkRequest) returns (DisplayVideo360AdvertiserLink) {
  441. option (google.api.http) = {
  442. get: "/v1alpha/{name=properties/*/displayVideo360AdvertiserLinks/*}"
  443. };
  444. option (google.api.method_signature) = "name";
  445. }
  446. // Lists all DisplayVideo360AdvertiserLinks on a property.
  447. rpc ListDisplayVideo360AdvertiserLinks(ListDisplayVideo360AdvertiserLinksRequest) returns (ListDisplayVideo360AdvertiserLinksResponse) {
  448. option (google.api.http) = {
  449. get: "/v1alpha/{parent=properties/*}/displayVideo360AdvertiserLinks"
  450. };
  451. option (google.api.method_signature) = "parent";
  452. }
  453. // Creates a DisplayVideo360AdvertiserLink.
  454. // This can only be utilized by users who have proper authorization both on
  455. // the Google Analytics property and on the Display & Video 360 advertiser.
  456. // Users who do not have access to the Display & Video 360 advertiser should
  457. // instead seek to create a DisplayVideo360LinkProposal.
  458. rpc CreateDisplayVideo360AdvertiserLink(CreateDisplayVideo360AdvertiserLinkRequest) returns (DisplayVideo360AdvertiserLink) {
  459. option (google.api.http) = {
  460. post: "/v1alpha/{parent=properties/*}/displayVideo360AdvertiserLinks"
  461. body: "display_video_360_advertiser_link"
  462. };
  463. option (google.api.method_signature) = "parent,display_video_360_advertiser_link";
  464. }
  465. // Deletes a DisplayVideo360AdvertiserLink on a property.
  466. rpc DeleteDisplayVideo360AdvertiserLink(DeleteDisplayVideo360AdvertiserLinkRequest) returns (google.protobuf.Empty) {
  467. option (google.api.http) = {
  468. delete: "/v1alpha/{name=properties/*/displayVideo360AdvertiserLinks/*}"
  469. };
  470. option (google.api.method_signature) = "name";
  471. }
  472. // Updates a DisplayVideo360AdvertiserLink on a property.
  473. rpc UpdateDisplayVideo360AdvertiserLink(UpdateDisplayVideo360AdvertiserLinkRequest) returns (DisplayVideo360AdvertiserLink) {
  474. option (google.api.http) = {
  475. patch: "/v1alpha/{display_video_360_advertiser_link.name=properties/*/displayVideo360AdvertiserLinks/*}"
  476. body: "display_video_360_advertiser_link"
  477. };
  478. option (google.api.method_signature) = "display_video_360_advertiser_link,update_mask";
  479. }
  480. // Lookup for a single DisplayVideo360AdvertiserLinkProposal.
  481. rpc GetDisplayVideo360AdvertiserLinkProposal(GetDisplayVideo360AdvertiserLinkProposalRequest) returns (DisplayVideo360AdvertiserLinkProposal) {
  482. option (google.api.http) = {
  483. get: "/v1alpha/{name=properties/*/displayVideo360AdvertiserLinkProposals/*}"
  484. };
  485. option (google.api.method_signature) = "name";
  486. }
  487. // Lists DisplayVideo360AdvertiserLinkProposals on a property.
  488. rpc ListDisplayVideo360AdvertiserLinkProposals(ListDisplayVideo360AdvertiserLinkProposalsRequest) returns (ListDisplayVideo360AdvertiserLinkProposalsResponse) {
  489. option (google.api.http) = {
  490. get: "/v1alpha/{parent=properties/*}/displayVideo360AdvertiserLinkProposals"
  491. };
  492. option (google.api.method_signature) = "parent";
  493. }
  494. // Creates a DisplayVideo360AdvertiserLinkProposal.
  495. rpc CreateDisplayVideo360AdvertiserLinkProposal(CreateDisplayVideo360AdvertiserLinkProposalRequest) returns (DisplayVideo360AdvertiserLinkProposal) {
  496. option (google.api.http) = {
  497. post: "/v1alpha/{parent=properties/*}/displayVideo360AdvertiserLinkProposals"
  498. body: "display_video_360_advertiser_link_proposal"
  499. };
  500. option (google.api.method_signature) = "parent,display_video_360_advertiser_link_proposal";
  501. }
  502. // Deletes a DisplayVideo360AdvertiserLinkProposal on a property.
  503. // This can only be used on cancelled proposals.
  504. rpc DeleteDisplayVideo360AdvertiserLinkProposal(DeleteDisplayVideo360AdvertiserLinkProposalRequest) returns (google.protobuf.Empty) {
  505. option (google.api.http) = {
  506. delete: "/v1alpha/{name=properties/*/displayVideo360AdvertiserLinkProposals/*}"
  507. };
  508. option (google.api.method_signature) = "name";
  509. }
  510. // Approves a DisplayVideo360AdvertiserLinkProposal.
  511. // The DisplayVideo360AdvertiserLinkProposal will be deleted and a new
  512. // DisplayVideo360AdvertiserLink will be created.
  513. rpc ApproveDisplayVideo360AdvertiserLinkProposal(ApproveDisplayVideo360AdvertiserLinkProposalRequest) returns (ApproveDisplayVideo360AdvertiserLinkProposalResponse) {
  514. option (google.api.http) = {
  515. post: "/v1alpha/{name=properties/*/displayVideo360AdvertiserLinkProposals/*}:approve"
  516. body: "*"
  517. };
  518. }
  519. // Cancels a DisplayVideo360AdvertiserLinkProposal.
  520. // Cancelling can mean either:
  521. // - Declining a proposal initiated from Display & Video 360
  522. // - Withdrawing a proposal initiated from Google Analytics
  523. // After being cancelled, a proposal will eventually be deleted automatically.
  524. rpc CancelDisplayVideo360AdvertiserLinkProposal(CancelDisplayVideo360AdvertiserLinkProposalRequest) returns (DisplayVideo360AdvertiserLinkProposal) {
  525. option (google.api.http) = {
  526. post: "/v1alpha/{name=properties/*/displayVideo360AdvertiserLinkProposals/*}:cancel"
  527. body: "*"
  528. };
  529. }
  530. // Creates a CustomDimension.
  531. rpc CreateCustomDimension(CreateCustomDimensionRequest) returns (CustomDimension) {
  532. option (google.api.http) = {
  533. post: "/v1alpha/{parent=properties/*}/customDimensions"
  534. body: "custom_dimension"
  535. };
  536. option (google.api.method_signature) = "parent,custom_dimension";
  537. }
  538. // Updates a CustomDimension on a property.
  539. rpc UpdateCustomDimension(UpdateCustomDimensionRequest) returns (CustomDimension) {
  540. option (google.api.http) = {
  541. patch: "/v1alpha/{custom_dimension.name=properties/*/customDimensions/*}"
  542. body: "custom_dimension"
  543. };
  544. option (google.api.method_signature) = "custom_dimension,update_mask";
  545. }
  546. // Lists CustomDimensions on a property.
  547. rpc ListCustomDimensions(ListCustomDimensionsRequest) returns (ListCustomDimensionsResponse) {
  548. option (google.api.http) = {
  549. get: "/v1alpha/{parent=properties/*}/customDimensions"
  550. };
  551. option (google.api.method_signature) = "parent";
  552. }
  553. // Archives a CustomDimension on a property.
  554. rpc ArchiveCustomDimension(ArchiveCustomDimensionRequest) returns (google.protobuf.Empty) {
  555. option (google.api.http) = {
  556. post: "/v1alpha/{name=properties/*/customDimensions/*}:archive"
  557. body: "*"
  558. };
  559. option (google.api.method_signature) = "name";
  560. }
  561. // Lookup for a single CustomDimension.
  562. rpc GetCustomDimension(GetCustomDimensionRequest) returns (CustomDimension) {
  563. option (google.api.http) = {
  564. get: "/v1alpha/{name=properties/*/customDimensions/*}"
  565. };
  566. option (google.api.method_signature) = "name";
  567. }
  568. // Creates a CustomMetric.
  569. rpc CreateCustomMetric(CreateCustomMetricRequest) returns (CustomMetric) {
  570. option (google.api.http) = {
  571. post: "/v1alpha/{parent=properties/*}/customMetrics"
  572. body: "custom_metric"
  573. };
  574. option (google.api.method_signature) = "parent,custom_metric";
  575. }
  576. // Updates a CustomMetric on a property.
  577. rpc UpdateCustomMetric(UpdateCustomMetricRequest) returns (CustomMetric) {
  578. option (google.api.http) = {
  579. patch: "/v1alpha/{custom_metric.name=properties/*/customMetrics/*}"
  580. body: "custom_metric"
  581. };
  582. option (google.api.method_signature) = "custom_metric,update_mask";
  583. }
  584. // Lists CustomMetrics on a property.
  585. rpc ListCustomMetrics(ListCustomMetricsRequest) returns (ListCustomMetricsResponse) {
  586. option (google.api.http) = {
  587. get: "/v1alpha/{parent=properties/*}/customMetrics"
  588. };
  589. option (google.api.method_signature) = "parent";
  590. }
  591. // Archives a CustomMetric on a property.
  592. rpc ArchiveCustomMetric(ArchiveCustomMetricRequest) returns (google.protobuf.Empty) {
  593. option (google.api.http) = {
  594. post: "/v1alpha/{name=properties/*/customMetrics/*}:archive"
  595. body: "*"
  596. };
  597. option (google.api.method_signature) = "name";
  598. }
  599. // Lookup for a single CustomMetric.
  600. rpc GetCustomMetric(GetCustomMetricRequest) returns (CustomMetric) {
  601. option (google.api.http) = {
  602. get: "/v1alpha/{name=properties/*/customMetrics/*}"
  603. };
  604. option (google.api.method_signature) = "name";
  605. }
  606. // Returns the singleton data retention settings for this property.
  607. rpc GetDataRetentionSettings(GetDataRetentionSettingsRequest) returns (DataRetentionSettings) {
  608. option (google.api.http) = {
  609. get: "/v1alpha/{name=properties/*/dataRetentionSettings}"
  610. };
  611. option (google.api.method_signature) = "name";
  612. }
  613. // Updates the singleton data retention settings for this property.
  614. rpc UpdateDataRetentionSettings(UpdateDataRetentionSettingsRequest) returns (DataRetentionSettings) {
  615. option (google.api.http) = {
  616. patch: "/v1alpha/{data_retention_settings.name=properties/*/dataRetentionSettings}"
  617. body: "data_retention_settings"
  618. };
  619. option (google.api.method_signature) = "data_retention_settings,update_mask";
  620. }
  621. // Creates a DataStream.
  622. rpc CreateDataStream(CreateDataStreamRequest) returns (DataStream) {
  623. option (google.api.http) = {
  624. post: "/v1alpha/{parent=properties/*}/dataStreams"
  625. body: "data_stream"
  626. };
  627. option (google.api.method_signature) = "parent,data_stream";
  628. }
  629. // Deletes a DataStream on a property.
  630. rpc DeleteDataStream(DeleteDataStreamRequest) returns (google.protobuf.Empty) {
  631. option (google.api.http) = {
  632. delete: "/v1alpha/{name=properties/*/dataStreams/*}"
  633. };
  634. option (google.api.method_signature) = "name";
  635. }
  636. // Updates a DataStream on a property.
  637. rpc UpdateDataStream(UpdateDataStreamRequest) returns (DataStream) {
  638. option (google.api.http) = {
  639. patch: "/v1alpha/{data_stream.name=properties/*/dataStreams/*}"
  640. body: "data_stream"
  641. };
  642. option (google.api.method_signature) = "data_stream,update_mask";
  643. }
  644. // Lists DataStreams on a property.
  645. rpc ListDataStreams(ListDataStreamsRequest) returns (ListDataStreamsResponse) {
  646. option (google.api.http) = {
  647. get: "/v1alpha/{parent=properties/*}/dataStreams"
  648. };
  649. option (google.api.method_signature) = "parent";
  650. }
  651. // Lookup for a single DataStream.
  652. rpc GetDataStream(GetDataStreamRequest) returns (DataStream) {
  653. option (google.api.http) = {
  654. get: "/v1alpha/{name=properties/*/dataStreams/*}"
  655. };
  656. option (google.api.method_signature) = "name";
  657. }
  658. // Lookup for a single Audience.
  659. // Audiences created before 2020 may not be supported.
  660. rpc GetAudience(GetAudienceRequest) returns (Audience) {
  661. option (google.api.http) = {
  662. get: "/v1alpha/{name=properties/*/audiences/*}"
  663. };
  664. option (google.api.method_signature) = "name";
  665. }
  666. // Lists Audiences on a property.
  667. // Audiences created before 2020 may not be supported.
  668. rpc ListAudiences(ListAudiencesRequest) returns (ListAudiencesResponse) {
  669. option (google.api.http) = {
  670. get: "/v1alpha/{parent=properties/*}/audiences"
  671. };
  672. option (google.api.method_signature) = "parent";
  673. }
  674. // Creates an Audience.
  675. rpc CreateAudience(CreateAudienceRequest) returns (Audience) {
  676. option (google.api.http) = {
  677. post: "/v1alpha/{parent=properties/*}/audiences"
  678. body: "audience"
  679. };
  680. option (google.api.method_signature) = "parent,audience";
  681. }
  682. // Updates an Audience on a property.
  683. rpc UpdateAudience(UpdateAudienceRequest) returns (Audience) {
  684. option (google.api.http) = {
  685. patch: "/v1alpha/{audience.name=properties/*/audiences/*}"
  686. body: "audience"
  687. };
  688. option (google.api.method_signature) = "audience,update_mask";
  689. }
  690. // Archives an Audience on a property.
  691. rpc ArchiveAudience(ArchiveAudienceRequest) returns (google.protobuf.Empty) {
  692. option (google.api.http) = {
  693. post: "/v1alpha/{name=properties/*/audiences/*}:archive"
  694. body: "*"
  695. };
  696. }
  697. // Lookup for a AttributionSettings singleton.
  698. rpc GetAttributionSettings(GetAttributionSettingsRequest) returns (AttributionSettings) {
  699. option (google.api.http) = {
  700. get: "/v1alpha/{name=properties/*/attributionSettings}"
  701. };
  702. option (google.api.method_signature) = "name";
  703. }
  704. // Updates attribution settings on a property.
  705. rpc UpdateAttributionSettings(UpdateAttributionSettingsRequest) returns (AttributionSettings) {
  706. option (google.api.http) = {
  707. patch: "/v1alpha/{attribution_settings.name=properties/*/attributionSettings}"
  708. body: "attribution_settings"
  709. };
  710. option (google.api.method_signature) = "attribution_settings,update_mask";
  711. }
  712. // Returns a customized report of data access records. The report provides
  713. // records of each time a user reads Google Analytics reporting data. Access
  714. // records are retained for up to 2 years.
  715. //
  716. // Data Access Reports can be requested for a property. The property must be
  717. // in Google Analytics 360. This method is only available to Administrators.
  718. //
  719. // These data access records include GA4 UI Reporting, GA4 UI Explorations,
  720. // GA4 Data API, and other products like Firebase & Admob that can retrieve
  721. // data from Google Analytics through a linkage. These records don't include
  722. // property configuration changes like adding a stream or changing a
  723. // property's time zone. For configuration change history, see
  724. // [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).
  725. rpc RunAccessReport(RunAccessReportRequest) returns (RunAccessReportResponse) {
  726. option (google.api.http) = {
  727. post: "/v1alpha/{entity=properties/*}:runAccessReport"
  728. body: "*"
  729. };
  730. }
  731. }
  732. // The request for a Data Access Record Report.
  733. message RunAccessReportRequest {
  734. // The Data Access Report is requested for this property.
  735. // For example if "123" is your GA4 property ID, then entity should be
  736. // "properties/123".
  737. string entity = 1;
  738. // The dimensions requested and displayed in the response. Requests are
  739. // allowed up to 9 dimensions.
  740. repeated AccessDimension dimensions = 2;
  741. // The metrics requested and displayed in the response. Requests are allowed
  742. // up to 10 metrics.
  743. repeated AccessMetric metrics = 3;
  744. // Date ranges of access records to read. If multiple date ranges are
  745. // requested, each response row will contain a zero based date range index. If
  746. // two date ranges overlap, the access records for the overlapping days is
  747. // included in the response rows for both date ranges. Requests are allowed up
  748. // to 2 date ranges.
  749. repeated AccessDateRange date_ranges = 4;
  750. // Dimension filters allow you to restrict report response to specific
  751. // dimension values which match the filter. For example, filtering on access
  752. // records of a single user. To learn more, see [Fundamentals of Dimension
  753. // Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters)
  754. // for examples. Metrics cannot be used in this filter.
  755. AccessFilterExpression dimension_filter = 5;
  756. // Metric filters allow you to restrict report response to specific metric
  757. // values which match the filter. Metric filters are applied after aggregating
  758. // the report's rows, similar to SQL having-clause. Dimensions cannot be used
  759. // in this filter.
  760. AccessFilterExpression metric_filter = 6;
  761. // The row count of the start row. The first row is counted as row 0. If
  762. // offset is unspecified, it is treated as 0. If offset is zero, then this
  763. // method will return the first page of results with `limit` entries.
  764. //
  765. // To learn more about this pagination parameter, see
  766. // [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
  767. int64 offset = 7;
  768. // The number of rows to return. If unspecified, 10,000 rows are returned. The
  769. // API returns a maximum of 100,000 rows per request, no matter how many you
  770. // ask for. `limit` must be positive.
  771. //
  772. // The API may return fewer rows than the requested `limit`, if there aren't
  773. // as many remaining rows as the `limit`. For instance, there are fewer than
  774. // 300 possible values for the dimension `country`, so when reporting on only
  775. // `country`, you can't get more than 300 rows, even if you set `limit` to a
  776. // higher value.
  777. //
  778. // To learn more about this pagination parameter, see
  779. // [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
  780. int64 limit = 8;
  781. // This request's time zone if specified. If unspecified, the property's time
  782. // zone is used. The request's time zone is used to interpret the start & end
  783. // dates of the report.
  784. //
  785. // Formatted as strings from the IANA Time Zone database
  786. // (https://www.iana.org/time-zones); for example "America/New_York" or
  787. // "Asia/Tokyo".
  788. string time_zone = 9;
  789. // Specifies how rows are ordered in the response.
  790. repeated AccessOrderBy order_bys = 10;
  791. // Toggles whether to return the current state of this Analytics Property's
  792. // quota. Quota is returned in [AccessQuota](#AccessQuota).
  793. bool return_entity_quota = 11;
  794. }
  795. // The customized Data Access Record Report response.
  796. message RunAccessReportResponse {
  797. // The header for a column in the report that corresponds to a specific
  798. // dimension. The number of DimensionHeaders and ordering of DimensionHeaders
  799. // matches the dimensions present in rows.
  800. repeated AccessDimensionHeader dimension_headers = 1;
  801. // The header for a column in the report that corresponds to a specific
  802. // metric. The number of MetricHeaders and ordering of MetricHeaders matches
  803. // the metrics present in rows.
  804. repeated AccessMetricHeader metric_headers = 2;
  805. // Rows of dimension value combinations and metric values in the report.
  806. repeated AccessRow rows = 3;
  807. // The total number of rows in the query result. `rowCount` is independent of
  808. // the number of rows returned in the response, the `limit` request
  809. // parameter, and the `offset` request parameter. For example if a query
  810. // returns 175 rows and includes `limit` of 50 in the API request, the
  811. // response will contain `rowCount` of 175 but only 50 rows.
  812. //
  813. // To learn more about this pagination parameter, see
  814. // [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
  815. int32 row_count = 4;
  816. // The quota state for this Analytics property including this request.
  817. AccessQuota quota = 5;
  818. }
  819. // Request message for GetAccount RPC.
  820. message GetAccountRequest {
  821. // Required. The name of the account to lookup.
  822. // Format: accounts/{account}
  823. // Example: "accounts/100"
  824. string name = 1 [
  825. (google.api.field_behavior) = REQUIRED,
  826. (google.api.resource_reference) = {
  827. type: "analyticsadmin.googleapis.com/Account"
  828. }
  829. ];
  830. }
  831. // Request message for ListAccounts RPC.
  832. message ListAccountsRequest {
  833. // The maximum number of resources to return. The service may return
  834. // fewer than this value, even if there are additional pages.
  835. // If unspecified, at most 50 resources will be returned.
  836. // The maximum value is 200; (higher values will be coerced to the maximum)
  837. int32 page_size = 1;
  838. // A page token, received from a previous `ListAccounts` call.
  839. // Provide this to retrieve the subsequent page.
  840. // When paginating, all other parameters provided to `ListAccounts` must
  841. // match the call that provided the page token.
  842. string page_token = 2;
  843. // Whether to include soft-deleted (ie: "trashed") Accounts in the
  844. // results. Accounts can be inspected to determine whether they are deleted or
  845. // not.
  846. bool show_deleted = 3;
  847. }
  848. // Request message for ListAccounts RPC.
  849. message ListAccountsResponse {
  850. // Results that were accessible to the caller.
  851. repeated Account accounts = 1;
  852. // A token, which can be sent as `page_token` to retrieve the next page.
  853. // If this field is omitted, there are no subsequent pages.
  854. string next_page_token = 2;
  855. }
  856. // Request message for DeleteAccount RPC.
  857. message DeleteAccountRequest {
  858. // Required. The name of the Account to soft-delete.
  859. // Format: accounts/{account}
  860. // Example: "accounts/100"
  861. string name = 1 [
  862. (google.api.field_behavior) = REQUIRED,
  863. (google.api.resource_reference) = {
  864. type: "analyticsadmin.googleapis.com/Account"
  865. }
  866. ];
  867. }
  868. // Request message for UpdateAccount RPC.
  869. message UpdateAccountRequest {
  870. // Required. The account to update.
  871. // The account's `name` field is used to identify the account.
  872. Account account = 1 [(google.api.field_behavior) = REQUIRED];
  873. // Required. The list of fields to be updated. Field names must be in snake case
  874. // (e.g., "field_to_update"). Omitted fields will not be updated. To replace
  875. // the entire entity, use one path with the string "*" to match all fields.
  876. google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
  877. }
  878. // Request message for ProvisionAccountTicket RPC.
  879. message ProvisionAccountTicketRequest {
  880. // The account to create.
  881. Account account = 1;
  882. // Redirect URI where the user will be sent after accepting Terms of Service.
  883. // Must be configured in Developers Console as a Redirect URI
  884. string redirect_uri = 2;
  885. }
  886. // Response message for ProvisionAccountTicket RPC.
  887. message ProvisionAccountTicketResponse {
  888. // The param to be passed in the ToS link.
  889. string account_ticket_id = 1;
  890. }
  891. // Request message for GetProperty RPC.
  892. message GetPropertyRequest {
  893. // Required. The name of the property to lookup.
  894. // Format: properties/{property_id}
  895. // Example: "properties/1000"
  896. string name = 1 [
  897. (google.api.field_behavior) = REQUIRED,
  898. (google.api.resource_reference) = {
  899. type: "analyticsadmin.googleapis.com/Property"
  900. }
  901. ];
  902. }
  903. // Request message for ListProperties RPC.
  904. message ListPropertiesRequest {
  905. // Required. An expression for filtering the results of the request.
  906. // Fields eligible for filtering are:
  907. // `parent:`(The resource name of the parent account/property) or
  908. // `ancestor:`(The resource name of the parent account) or
  909. // `firebase_project:`(The id or number of the linked firebase project).
  910. // Some examples of filters:
  911. //
  912. // ```
  913. // | Filter | Description |
  914. // |-----------------------------|-------------------------------------------|
  915. // | parent:accounts/123 | The account with account id: 123. |
  916. // | parent:properties/123 | The property with property id: 123. |
  917. // | ancestor:accounts/123 | The account with account id: 123. |
  918. // | firebase_project:project-id | The firebase project with id: project-id. |
  919. // | firebase_project:123 | The firebase project with number: 123. |
  920. // ```
  921. string filter = 1 [(google.api.field_behavior) = REQUIRED];
  922. // The maximum number of resources to return. The service may return
  923. // fewer than this value, even if there are additional pages.
  924. // If unspecified, at most 50 resources will be returned.
  925. // The maximum value is 200; (higher values will be coerced to the maximum)
  926. int32 page_size = 2;
  927. // A page token, received from a previous `ListProperties` call.
  928. // Provide this to retrieve the subsequent page.
  929. // When paginating, all other parameters provided to `ListProperties` must
  930. // match the call that provided the page token.
  931. string page_token = 3;
  932. // Whether to include soft-deleted (ie: "trashed") Properties in the
  933. // results. Properties can be inspected to determine whether they are deleted
  934. // or not.
  935. bool show_deleted = 4;
  936. }
  937. // Response message for ListProperties RPC.
  938. message ListPropertiesResponse {
  939. // Results that matched the filter criteria and were accessible to the caller.
  940. repeated Property properties = 1;
  941. // A token, which can be sent as `page_token` to retrieve the next page.
  942. // If this field is omitted, there are no subsequent pages.
  943. string next_page_token = 2;
  944. }
  945. // Request message for UpdateProperty RPC.
  946. message UpdatePropertyRequest {
  947. // Required. The property to update.
  948. // The property's `name` field is used to identify the property to be
  949. // updated.
  950. Property property = 1 [(google.api.field_behavior) = REQUIRED];
  951. // Required. The list of fields to be updated. Field names must be in snake case
  952. // (e.g., "field_to_update"). Omitted fields will not be updated. To replace
  953. // the entire entity, use one path with the string "*" to match all fields.
  954. google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
  955. }
  956. // Request message for CreateProperty RPC.
  957. message CreatePropertyRequest {
  958. // Required. The property to create.
  959. // Note: the supplied property must specify its parent.
  960. Property property = 1 [(google.api.field_behavior) = REQUIRED];
  961. }
  962. // Request message for DeleteProperty RPC.
  963. message DeletePropertyRequest {
  964. // Required. The name of the Property to soft-delete.
  965. // Format: properties/{property_id}
  966. // Example: "properties/1000"
  967. string name = 1 [
  968. (google.api.field_behavior) = REQUIRED,
  969. (google.api.resource_reference) = {
  970. type: "analyticsadmin.googleapis.com/Property"
  971. }
  972. ];
  973. }
  974. // Request message for GetUserLink RPC.
  975. message GetUserLinkRequest {
  976. // Required. Example format: accounts/1234/userLinks/5678
  977. string name = 1 [
  978. (google.api.field_behavior) = REQUIRED,
  979. (google.api.resource_reference) = {
  980. type: "analyticsadmin.googleapis.com/UserLink"
  981. }
  982. ];
  983. }
  984. // Request message for BatchGetUserLinks RPC.
  985. message BatchGetUserLinksRequest {
  986. // Required. The account or property that all user links in the request are
  987. // for. The parent of all provided values for the 'names' field must match
  988. // this field.
  989. // Example format: accounts/1234
  990. string parent = 1 [
  991. (google.api.field_behavior) = REQUIRED,
  992. (google.api.resource_reference) = {
  993. child_type: "analyticsadmin.googleapis.com/UserLink"
  994. }
  995. ];
  996. // Required. The names of the user links to retrieve.
  997. // A maximum of 1000 user links can be retrieved in a batch.
  998. // Format: accounts/{accountId}/userLinks/{userLinkId}
  999. repeated string names = 2 [
  1000. (google.api.field_behavior) = REQUIRED,
  1001. (google.api.resource_reference) = {
  1002. type: "analyticsadmin.googleapis.com/UserLink"
  1003. }
  1004. ];
  1005. }
  1006. // Response message for BatchGetUserLinks RPC.
  1007. message BatchGetUserLinksResponse {
  1008. // The requested user links.
  1009. repeated UserLink user_links = 1;
  1010. }
  1011. // Request message for ListUserLinks RPC.
  1012. message ListUserLinksRequest {
  1013. // Required. Example format: accounts/1234
  1014. string parent = 1 [
  1015. (google.api.field_behavior) = REQUIRED,
  1016. (google.api.resource_reference) = {
  1017. child_type: "analyticsadmin.googleapis.com/UserLink"
  1018. }
  1019. ];
  1020. // The maximum number of user links to return.
  1021. // The service may return fewer than this value.
  1022. // If unspecified, at most 200 user links will be returned.
  1023. // The maximum value is 500; values above 500 will be coerced to 500.
  1024. int32 page_size = 2;
  1025. // A page token, received from a previous `ListUserLinks` call.
  1026. // Provide this to retrieve the subsequent page.
  1027. // When paginating, all other parameters provided to `ListUserLinks` must
  1028. // match the call that provided the page token.
  1029. string page_token = 3;
  1030. }
  1031. // Response message for ListUserLinks RPC.
  1032. message ListUserLinksResponse {
  1033. // List of UserLinks. These will be ordered stably, but in an arbitrary order.
  1034. repeated UserLink user_links = 1;
  1035. // A token, which can be sent as `page_token` to retrieve the next page.
  1036. // If this field is omitted, there are no subsequent pages.
  1037. string next_page_token = 2;
  1038. }
  1039. // Request message for AuditUserLinks RPC.
  1040. message AuditUserLinksRequest {
  1041. // Required. Example format: accounts/1234
  1042. string parent = 1 [
  1043. (google.api.field_behavior) = REQUIRED,
  1044. (google.api.resource_reference) = {
  1045. child_type: "analyticsadmin.googleapis.com/UserLink"
  1046. }
  1047. ];
  1048. // The maximum number of user links to return.
  1049. // The service may return fewer than this value.
  1050. // If unspecified, at most 1000 user links will be returned.
  1051. // The maximum value is 5000; values above 5000 will be coerced to 5000.
  1052. int32 page_size = 2;
  1053. // A page token, received from a previous `AuditUserLinks` call.
  1054. // Provide this to retrieve the subsequent page.
  1055. // When paginating, all other parameters provided to `AuditUserLinks` must
  1056. // match the call that provided the page token.
  1057. string page_token = 3;
  1058. }
  1059. // Response message for AuditUserLinks RPC.
  1060. message AuditUserLinksResponse {
  1061. // List of AuditUserLinks. These will be ordered stably, but in an arbitrary
  1062. // order.
  1063. repeated AuditUserLink user_links = 1;
  1064. // A token, which can be sent as `page_token` to retrieve the next page.
  1065. // If this field is omitted, there are no subsequent pages.
  1066. string next_page_token = 2;
  1067. }
  1068. // Request message for CreateUserLink RPC.
  1069. //
  1070. // Users can have multiple email addresses associated with their Google
  1071. // account, and one of these email addresses is the "primary" email address.
  1072. // Any of the email addresses associated with a Google account may be used
  1073. // for a new UserLink, but the returned UserLink will always contain the
  1074. // "primary" email address. As a result, the input and output email address
  1075. // for this request may differ.
  1076. message CreateUserLinkRequest {
  1077. // Required. Example format: accounts/1234
  1078. string parent = 1 [
  1079. (google.api.field_behavior) = REQUIRED,
  1080. (google.api.resource_reference) = {
  1081. child_type: "analyticsadmin.googleapis.com/UserLink"
  1082. }
  1083. ];
  1084. // Optional. If set, then email the new user notifying them that they've been granted
  1085. // permissions to the resource.
  1086. bool notify_new_user = 2 [(google.api.field_behavior) = OPTIONAL];
  1087. // Required. The user link to create.
  1088. UserLink user_link = 3 [(google.api.field_behavior) = REQUIRED];
  1089. }
  1090. // Request message for BatchCreateUserLinks RPC.
  1091. message BatchCreateUserLinksRequest {
  1092. // Required. The account or property that all user links in the request are for.
  1093. // This field is required. The parent field in the CreateUserLinkRequest
  1094. // messages must either be empty or match this field.
  1095. // Example format: accounts/1234
  1096. string parent = 1 [
  1097. (google.api.field_behavior) = REQUIRED,
  1098. (google.api.resource_reference) = {
  1099. child_type: "analyticsadmin.googleapis.com/UserLink"
  1100. }
  1101. ];
  1102. // Optional. If set, then email the new users notifying them that they've been granted
  1103. // permissions to the resource. Regardless of whether this is set or not,
  1104. // notify_new_user field inside each individual request is ignored.
  1105. bool notify_new_users = 2 [(google.api.field_behavior) = OPTIONAL];
  1106. // Required. The requests specifying the user links to create.
  1107. // A maximum of 1000 user links can be created in a batch.
  1108. repeated CreateUserLinkRequest requests = 3 [(google.api.field_behavior) = REQUIRED];
  1109. }
  1110. // Response message for BatchCreateUserLinks RPC.
  1111. message BatchCreateUserLinksResponse {
  1112. // The user links created.
  1113. repeated UserLink user_links = 1;
  1114. }
  1115. // Request message for UpdateUserLink RPC.
  1116. message UpdateUserLinkRequest {
  1117. // Required. The user link to update.
  1118. UserLink user_link = 1 [(google.api.field_behavior) = REQUIRED];
  1119. }
  1120. // Request message for BatchUpdateUserLinks RPC.
  1121. message BatchUpdateUserLinksRequest {
  1122. // Required. The account or property that all user links in the request are
  1123. // for. The parent field in the UpdateUserLinkRequest messages must either be
  1124. // empty or match this field.
  1125. // Example format: accounts/1234
  1126. string parent = 1 [
  1127. (google.api.field_behavior) = REQUIRED,
  1128. (google.api.resource_reference) = {
  1129. child_type: "analyticsadmin.googleapis.com/UserLink"
  1130. }
  1131. ];
  1132. // Required. The requests specifying the user links to update.
  1133. // A maximum of 1000 user links can be updated in a batch.
  1134. repeated UpdateUserLinkRequest requests = 2 [(google.api.field_behavior) = REQUIRED];
  1135. }
  1136. // Response message for BatchUpdateUserLinks RPC.
  1137. message BatchUpdateUserLinksResponse {
  1138. // The user links updated.
  1139. repeated UserLink user_links = 1;
  1140. }
  1141. // Request message for DeleteUserLink RPC.
  1142. message DeleteUserLinkRequest {
  1143. // Required. Example format: accounts/1234/userLinks/5678
  1144. string name = 1 [
  1145. (google.api.field_behavior) = REQUIRED,
  1146. (google.api.resource_reference) = {
  1147. type: "analyticsadmin.googleapis.com/UserLink"
  1148. }
  1149. ];
  1150. }
  1151. // Request message for BatchDeleteUserLinks RPC.
  1152. message BatchDeleteUserLinksRequest {
  1153. // Required. The account or property that all user links in the request are
  1154. // for. The parent of all values for user link names to delete must match this
  1155. // field.
  1156. // Example format: accounts/1234
  1157. string parent = 1 [
  1158. (google.api.field_behavior) = REQUIRED,
  1159. (google.api.resource_reference) = {
  1160. child_type: "analyticsadmin.googleapis.com/UserLink"
  1161. }
  1162. ];
  1163. // Required. The requests specifying the user links to update.
  1164. // A maximum of 1000 user links can be updated in a batch.
  1165. repeated DeleteUserLinkRequest requests = 2 [(google.api.field_behavior) = REQUIRED];
  1166. }
  1167. // Request message for CreateFirebaseLink RPC
  1168. message CreateFirebaseLinkRequest {
  1169. // Required. Format: properties/{property_id}
  1170. // Example: properties/1234
  1171. string parent = 1 [
  1172. (google.api.field_behavior) = REQUIRED,
  1173. (google.api.resource_reference) = {
  1174. child_type: "analyticsadmin.googleapis.com/FirebaseLink"
  1175. }
  1176. ];
  1177. // Required. The Firebase link to create.
  1178. FirebaseLink firebase_link = 2 [(google.api.field_behavior) = REQUIRED];
  1179. }
  1180. // Request message for DeleteFirebaseLink RPC
  1181. message DeleteFirebaseLinkRequest {
  1182. // Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id}
  1183. // Example: properties/1234/firebaseLinks/5678
  1184. string name = 1 [
  1185. (google.api.field_behavior) = REQUIRED,
  1186. (google.api.resource_reference) = {
  1187. type: "analyticsadmin.googleapis.com/FirebaseLink"
  1188. }
  1189. ];
  1190. }
  1191. // Request message for ListFirebaseLinks RPC
  1192. message ListFirebaseLinksRequest {
  1193. // Required. Format: properties/{property_id}
  1194. // Example: properties/1234
  1195. string parent = 1 [
  1196. (google.api.field_behavior) = REQUIRED,
  1197. (google.api.resource_reference) = {
  1198. child_type: "analyticsadmin.googleapis.com/FirebaseLink"
  1199. }
  1200. ];
  1201. // The maximum number of resources to return. The service may return
  1202. // fewer than this value, even if there are additional pages.
  1203. // If unspecified, at most 50 resources will be returned.
  1204. // The maximum value is 200; (higher values will be coerced to the maximum)
  1205. int32 page_size = 2;
  1206. // A page token, received from a previous `ListFirebaseLinks` call.
  1207. // Provide this to retrieve the subsequent page.
  1208. // When paginating, all other parameters provided to `ListProperties` must
  1209. // match the call that provided the page token.
  1210. string page_token = 3;
  1211. }
  1212. // Response message for ListFirebaseLinks RPC
  1213. message ListFirebaseLinksResponse {
  1214. // List of FirebaseLinks. This will have at most one value.
  1215. repeated FirebaseLink firebase_links = 1;
  1216. // A token, which can be sent as `page_token` to retrieve the next page.
  1217. // If this field is omitted, there are no subsequent pages.
  1218. // Currently, Google Analytics supports only one FirebaseLink per property,
  1219. // so this will never be populated.
  1220. string next_page_token = 2;
  1221. }
  1222. // Request message for GetGlobalSiteTag RPC.
  1223. message GetGlobalSiteTagRequest {
  1224. // Required. The name of the site tag to lookup.
  1225. // Note that site tags are singletons and do not have unique IDs.
  1226. // Format: properties/{property_id}/dataStreams/{stream_id}/globalSiteTag
  1227. // Example: "properties/123/dataStreams/456/globalSiteTag"
  1228. string name = 1 [
  1229. (google.api.field_behavior) = REQUIRED,
  1230. (google.api.resource_reference) = {
  1231. type: "analyticsadmin.googleapis.com/GlobalSiteTag"
  1232. }
  1233. ];
  1234. }
  1235. // Request message for CreateGoogleAdsLink RPC
  1236. message CreateGoogleAdsLinkRequest {
  1237. // Required. Example format: properties/1234
  1238. string parent = 1 [
  1239. (google.api.field_behavior) = REQUIRED,
  1240. (google.api.resource_reference) = {
  1241. child_type: "analyticsadmin.googleapis.com/GoogleAdsLink"
  1242. }
  1243. ];
  1244. // Required. The GoogleAdsLink to create.
  1245. GoogleAdsLink google_ads_link = 2 [(google.api.field_behavior) = REQUIRED];
  1246. }
  1247. // Request message for UpdateGoogleAdsLink RPC
  1248. message UpdateGoogleAdsLinkRequest {
  1249. // The GoogleAdsLink to update
  1250. GoogleAdsLink google_ads_link = 1;
  1251. // Required. The list of fields to be updated. Field names must be in snake case
  1252. // (e.g., "field_to_update"). Omitted fields will not be updated. To replace
  1253. // the entire entity, use one path with the string "*" to match all fields.
  1254. google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
  1255. }
  1256. // Request message for DeleteGoogleAdsLink RPC.
  1257. message DeleteGoogleAdsLinkRequest {
  1258. // Required. Example format: properties/1234/googleAdsLinks/5678
  1259. string name = 1 [
  1260. (google.api.field_behavior) = REQUIRED,
  1261. (google.api.resource_reference) = {
  1262. type: "analyticsadmin.googleapis.com/GoogleAdsLink"
  1263. }
  1264. ];
  1265. }
  1266. // Request message for ListGoogleAdsLinks RPC.
  1267. message ListGoogleAdsLinksRequest {
  1268. // Required. Example format: properties/1234
  1269. string parent = 1 [
  1270. (google.api.field_behavior) = REQUIRED,
  1271. (google.api.resource_reference) = {
  1272. child_type: "analyticsadmin.googleapis.com/GoogleAdsLink"
  1273. }
  1274. ];
  1275. // The maximum number of resources to return.
  1276. // If unspecified, at most 50 resources will be returned.
  1277. // The maximum value is 200 (higher values will be coerced to the maximum).
  1278. int32 page_size = 2;
  1279. // A page token, received from a previous `ListGoogleAdsLinks` call.
  1280. // Provide this to retrieve the subsequent page.
  1281. //
  1282. // When paginating, all other parameters provided to `ListGoogleAdsLinks` must
  1283. // match the call that provided the page token.
  1284. string page_token = 3;
  1285. }
  1286. // Response message for ListGoogleAdsLinks RPC.
  1287. message ListGoogleAdsLinksResponse {
  1288. // List of GoogleAdsLinks.
  1289. repeated GoogleAdsLink google_ads_links = 1;
  1290. // A token, which can be sent as `page_token` to retrieve the next page.
  1291. // If this field is omitted, there are no subsequent pages.
  1292. string next_page_token = 2;
  1293. }
  1294. // Request message for GetDataSharingSettings RPC.
  1295. message GetDataSharingSettingsRequest {
  1296. // Required. The name of the settings to lookup.
  1297. // Format: accounts/{account}/dataSharingSettings
  1298. // Example: "accounts/1000/dataSharingSettings"
  1299. string name = 1 [
  1300. (google.api.field_behavior) = REQUIRED,
  1301. (google.api.resource_reference) = {
  1302. type: "analyticsadmin.googleapis.com/DataSharingSettings"
  1303. }
  1304. ];
  1305. }
  1306. // Request message for ListAccountSummaries RPC.
  1307. message ListAccountSummariesRequest {
  1308. // The maximum number of AccountSummary resources to return. The service may
  1309. // return fewer than this value, even if there are additional pages.
  1310. // If unspecified, at most 50 resources will be returned.
  1311. // The maximum value is 200; (higher values will be coerced to the maximum)
  1312. int32 page_size = 1;
  1313. // A page token, received from a previous `ListAccountSummaries` call.
  1314. // Provide this to retrieve the subsequent page.
  1315. // When paginating, all other parameters provided to `ListAccountSummaries`
  1316. // must match the call that provided the page token.
  1317. string page_token = 2;
  1318. }
  1319. // Response message for ListAccountSummaries RPC.
  1320. message ListAccountSummariesResponse {
  1321. // Account summaries of all accounts the caller has access to.
  1322. repeated AccountSummary account_summaries = 1;
  1323. // A token, which can be sent as `page_token` to retrieve the next page.
  1324. // If this field is omitted, there are no subsequent pages.
  1325. string next_page_token = 2;
  1326. }
  1327. // Request message for AcknowledgeUserDataCollection RPC.
  1328. message AcknowledgeUserDataCollectionRequest {
  1329. // Required. The property for which to acknowledge user data collection.
  1330. string property = 1 [
  1331. (google.api.field_behavior) = REQUIRED,
  1332. (google.api.resource_reference) = {
  1333. type: "analyticsadmin.googleapis.com/Property"
  1334. }
  1335. ];
  1336. // Required. An acknowledgement that the caller of this method understands the terms
  1337. // of user data collection.
  1338. //
  1339. // This field must contain the exact value:
  1340. // "I acknowledge that I have the necessary privacy disclosures and rights
  1341. // from my end users for the collection and processing of their data,
  1342. // including the association of such data with the visitation information
  1343. // Google Analytics collects from my site and/or app property."
  1344. string acknowledgement = 2 [(google.api.field_behavior) = REQUIRED];
  1345. }
  1346. // Response message for AcknowledgeUserDataCollection RPC.
  1347. message AcknowledgeUserDataCollectionResponse {
  1348. }
  1349. // Request message for SearchChangeHistoryEvents RPC.
  1350. message SearchChangeHistoryEventsRequest {
  1351. // Required. The account resource for which to return change history resources.
  1352. string account = 1 [
  1353. (google.api.field_behavior) = REQUIRED,
  1354. (google.api.resource_reference) = {
  1355. type: "analyticsadmin.googleapis.com/Account"
  1356. }
  1357. ];
  1358. // Optional. Resource name for a child property. If set, only return changes
  1359. // made to this property or its child resources.
  1360. string property = 2 [
  1361. (google.api.field_behavior) = OPTIONAL,
  1362. (google.api.resource_reference) = {
  1363. type: "analyticsadmin.googleapis.com/Property"
  1364. }
  1365. ];
  1366. // Optional. If set, only return changes if they are for a resource that matches at
  1367. // least one of these types.
  1368. repeated ChangeHistoryResourceType resource_type = 3 [(google.api.field_behavior) = OPTIONAL];
  1369. // Optional. If set, only return changes that match one or more of these types of
  1370. // actions.
  1371. repeated ActionType action = 4 [(google.api.field_behavior) = OPTIONAL];
  1372. // Optional. If set, only return changes if they are made by a user in this list.
  1373. repeated string actor_email = 5 [(google.api.field_behavior) = OPTIONAL];
  1374. // Optional. If set, only return changes made after this time (inclusive).
  1375. google.protobuf.Timestamp earliest_change_time = 6 [(google.api.field_behavior) = OPTIONAL];
  1376. // Optional. If set, only return changes made before this time (inclusive).
  1377. google.protobuf.Timestamp latest_change_time = 7 [(google.api.field_behavior) = OPTIONAL];
  1378. // Optional. The maximum number of ChangeHistoryEvent items to return.
  1379. // The service may return fewer than this value, even if there are additional
  1380. // pages. If unspecified, at most 50 items will be returned.
  1381. // The maximum value is 200 (higher values will be coerced to the maximum).
  1382. int32 page_size = 8 [(google.api.field_behavior) = OPTIONAL];
  1383. // Optional. A page token, received from a previous `SearchChangeHistoryEvents` call.
  1384. // Provide this to retrieve the subsequent page. When paginating, all other
  1385. // parameters provided to `SearchChangeHistoryEvents` must match the call that
  1386. // provided the page token.
  1387. string page_token = 9 [(google.api.field_behavior) = OPTIONAL];
  1388. }
  1389. // Response message for SearchAccounts RPC.
  1390. message SearchChangeHistoryEventsResponse {
  1391. // Results that were accessible to the caller.
  1392. repeated ChangeHistoryEvent change_history_events = 1;
  1393. // A token, which can be sent as `page_token` to retrieve the next page.
  1394. // If this field is omitted, there are no subsequent pages.
  1395. string next_page_token = 2;
  1396. }
  1397. // Request message for GetMeasurementProtocolSecret RPC.
  1398. message GetMeasurementProtocolSecretRequest {
  1399. // Required. The name of the measurement protocol secret to lookup.
  1400. // Format:
  1401. // properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
  1402. string name = 1 [
  1403. (google.api.field_behavior) = REQUIRED,
  1404. (google.api.resource_reference) = {
  1405. type: "analyticsadmin.googleapis.com/MeasurementProtocolSecret"
  1406. }
  1407. ];
  1408. }
  1409. // Request message for CreateMeasurementProtocolSecret RPC
  1410. message CreateMeasurementProtocolSecretRequest {
  1411. // Required. The parent resource where this secret will be created.
  1412. // Format: properties/{property}/dataStreams/{dataStream}
  1413. string parent = 1 [
  1414. (google.api.field_behavior) = REQUIRED,
  1415. (google.api.resource_reference) = {
  1416. child_type: "analyticsadmin.googleapis.com/MeasurementProtocolSecret"
  1417. }
  1418. ];
  1419. // Required. The measurement protocol secret to create.
  1420. MeasurementProtocolSecret measurement_protocol_secret = 2 [(google.api.field_behavior) = REQUIRED];
  1421. }
  1422. // Request message for DeleteMeasurementProtocolSecret RPC
  1423. message DeleteMeasurementProtocolSecretRequest {
  1424. // Required. The name of the MeasurementProtocolSecret to delete.
  1425. // Format:
  1426. // properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
  1427. string name = 1 [
  1428. (google.api.field_behavior) = REQUIRED,
  1429. (google.api.resource_reference) = {
  1430. type: "analyticsadmin.googleapis.com/MeasurementProtocolSecret"
  1431. }
  1432. ];
  1433. }
  1434. // Request message for UpdateMeasurementProtocolSecret RPC
  1435. message UpdateMeasurementProtocolSecretRequest {
  1436. // Required. The measurement protocol secret to update.
  1437. MeasurementProtocolSecret measurement_protocol_secret = 1 [(google.api.field_behavior) = REQUIRED];
  1438. // The list of fields to be updated. Omitted fields will not be updated.
  1439. google.protobuf.FieldMask update_mask = 2;
  1440. }
  1441. // Request message for ListMeasurementProtocolSecret RPC
  1442. message ListMeasurementProtocolSecretsRequest {
  1443. // Required. The resource name of the parent stream.
  1444. // Format:
  1445. // properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets
  1446. string parent = 1 [
  1447. (google.api.field_behavior) = REQUIRED,
  1448. (google.api.resource_reference) = {
  1449. child_type: "analyticsadmin.googleapis.com/MeasurementProtocolSecret"
  1450. }
  1451. ];
  1452. // The maximum number of resources to return.
  1453. // If unspecified, at most 10 resources will be returned.
  1454. // The maximum value is 10. Higher values will be coerced to the maximum.
  1455. int32 page_size = 2;
  1456. // A page token, received from a previous `ListMeasurementProtocolSecrets`
  1457. // call. Provide this to retrieve the subsequent page. When paginating, all
  1458. // other parameters provided to `ListMeasurementProtocolSecrets` must match
  1459. // the call that provided the page token.
  1460. string page_token = 3;
  1461. }
  1462. // Response message for ListMeasurementProtocolSecret RPC
  1463. message ListMeasurementProtocolSecretsResponse {
  1464. // A list of secrets for the parent stream specified in the request.
  1465. repeated MeasurementProtocolSecret measurement_protocol_secrets = 1;
  1466. // A token, which can be sent as `page_token` to retrieve the next page.
  1467. // If this field is omitted, there are no subsequent pages.
  1468. string next_page_token = 2;
  1469. }
  1470. // Request message for GetGoogleSignalsSettings RPC
  1471. message GetGoogleSignalsSettingsRequest {
  1472. // Required. The name of the google signals settings to retrieve.
  1473. // Format: properties/{property}/googleSignalsSettings
  1474. string name = 1 [
  1475. (google.api.field_behavior) = REQUIRED,
  1476. (google.api.resource_reference) = {
  1477. type: "analyticsadmin.googleapis.com/GoogleSignalsSettings"
  1478. }
  1479. ];
  1480. }
  1481. // Request message for UpdateGoogleSignalsSettings RPC
  1482. message UpdateGoogleSignalsSettingsRequest {
  1483. // Required. The settings to update.
  1484. // The `name` field is used to identify the settings to be updated.
  1485. GoogleSignalsSettings google_signals_settings = 1 [(google.api.field_behavior) = REQUIRED];
  1486. // Required. The list of fields to be updated. Field names must be in snake case
  1487. // (e.g., "field_to_update"). Omitted fields will not be updated. To replace
  1488. // the entire entity, use one path with the string "*" to match all fields.
  1489. google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
  1490. }
  1491. // Request message for CreateConversionEvent RPC
  1492. message CreateConversionEventRequest {
  1493. // Required. The conversion event to create.
  1494. ConversionEvent conversion_event = 1 [(google.api.field_behavior) = REQUIRED];
  1495. // Required. The resource name of the parent property where this conversion event will
  1496. // be created. Format: properties/123
  1497. string parent = 2 [
  1498. (google.api.field_behavior) = REQUIRED,
  1499. (google.api.resource_reference) = {
  1500. child_type: "analyticsadmin.googleapis.com/ConversionEvent"
  1501. }
  1502. ];
  1503. }
  1504. // Request message for GetConversionEvent RPC
  1505. message GetConversionEventRequest {
  1506. // Required. The resource name of the conversion event to retrieve.
  1507. // Format: properties/{property}/conversionEvents/{conversion_event}
  1508. // Example: "properties/123/conversionEvents/456"
  1509. string name = 1 [
  1510. (google.api.field_behavior) = REQUIRED,
  1511. (google.api.resource_reference) = {
  1512. type: "analyticsadmin.googleapis.com/ConversionEvent"
  1513. }
  1514. ];
  1515. }
  1516. // Request message for DeleteConversionEvent RPC
  1517. message DeleteConversionEventRequest {
  1518. // Required. The resource name of the conversion event to delete.
  1519. // Format: properties/{property}/conversionEvents/{conversion_event}
  1520. // Example: "properties/123/conversionEvents/456"
  1521. string name = 1 [
  1522. (google.api.field_behavior) = REQUIRED,
  1523. (google.api.resource_reference) = {
  1524. type: "analyticsadmin.googleapis.com/ConversionEvent"
  1525. }
  1526. ];
  1527. }
  1528. // Request message for ListConversionEvents RPC
  1529. message ListConversionEventsRequest {
  1530. // Required. The resource name of the parent property.
  1531. // Example: 'properties/123'
  1532. string parent = 1 [
  1533. (google.api.field_behavior) = REQUIRED,
  1534. (google.api.resource_reference) = {
  1535. child_type: "analyticsadmin.googleapis.com/ConversionEvent"
  1536. }
  1537. ];
  1538. // The maximum number of resources to return.
  1539. // If unspecified, at most 50 resources will be returned.
  1540. // The maximum value is 200; (higher values will be coerced to the maximum)
  1541. int32 page_size = 2;
  1542. // A page token, received from a previous `ListConversionEvents` call.
  1543. // Provide this to retrieve the subsequent page.
  1544. // When paginating, all other parameters provided to `ListConversionEvents`
  1545. // must match the call that provided the page token.
  1546. string page_token = 3;
  1547. }
  1548. // Response message for ListConversionEvents RPC.
  1549. message ListConversionEventsResponse {
  1550. // The requested conversion events
  1551. repeated ConversionEvent conversion_events = 1;
  1552. // A token, which can be sent as `page_token` to retrieve the next page.
  1553. // If this field is omitted, there are no subsequent pages.
  1554. string next_page_token = 2;
  1555. }
  1556. // Request message for GetDisplayVideo360AdvertiserLink RPC.
  1557. message GetDisplayVideo360AdvertiserLinkRequest {
  1558. // Required. The name of the DisplayVideo360AdvertiserLink to get.
  1559. // Example format: properties/1234/displayVideo360AdvertiserLink/5678
  1560. string name = 1 [
  1561. (google.api.field_behavior) = REQUIRED,
  1562. (google.api.resource_reference) = {
  1563. type: "analyticsadmin.googleapis.com/DisplayVideo360AdvertiserLink"
  1564. }
  1565. ];
  1566. }
  1567. // Request message for ListDisplayVideo360AdvertiserLinks RPC.
  1568. message ListDisplayVideo360AdvertiserLinksRequest {
  1569. // Required. Example format: properties/1234
  1570. string parent = 1 [
  1571. (google.api.field_behavior) = REQUIRED,
  1572. (google.api.resource_reference) = {
  1573. child_type: "analyticsadmin.googleapis.com/DisplayVideo360AdvertiserLink"
  1574. }
  1575. ];
  1576. // The maximum number of resources to return.
  1577. // If unspecified, at most 50 resources will be returned.
  1578. // The maximum value is 200 (higher values will be coerced to the maximum).
  1579. int32 page_size = 2;
  1580. // A page token, received from a previous `ListDisplayVideo360AdvertiserLinks`
  1581. // call. Provide this to retrieve the subsequent page.
  1582. //
  1583. // When paginating, all other parameters provided to
  1584. // `ListDisplayVideo360AdvertiserLinks` must match the call that provided the
  1585. // page token.
  1586. string page_token = 3;
  1587. }
  1588. // Response message for ListDisplayVideo360AdvertiserLinks RPC.
  1589. message ListDisplayVideo360AdvertiserLinksResponse {
  1590. // List of DisplayVideo360AdvertiserLinks.
  1591. repeated DisplayVideo360AdvertiserLink display_video_360_advertiser_links = 1;
  1592. // A token, which can be sent as `page_token` to retrieve the next page.
  1593. // If this field is omitted, there are no subsequent pages.
  1594. string next_page_token = 2;
  1595. }
  1596. // Request message for CreateDisplayVideo360AdvertiserLink RPC.
  1597. message CreateDisplayVideo360AdvertiserLinkRequest {
  1598. // Required. Example format: properties/1234
  1599. string parent = 1 [
  1600. (google.api.field_behavior) = REQUIRED,
  1601. (google.api.resource_reference) = {
  1602. child_type: "analyticsadmin.googleapis.com/DisplayVideo360AdvertiserLink"
  1603. }
  1604. ];
  1605. // Required. The DisplayVideo360AdvertiserLink to create.
  1606. DisplayVideo360AdvertiserLink display_video_360_advertiser_link = 2 [(google.api.field_behavior) = REQUIRED];
  1607. }
  1608. // Request message for DeleteDisplayVideo360AdvertiserLink RPC.
  1609. message DeleteDisplayVideo360AdvertiserLinkRequest {
  1610. // Required. The name of the DisplayVideo360AdvertiserLink to delete.
  1611. // Example format: properties/1234/displayVideo360AdvertiserLinks/5678
  1612. string name = 1 [
  1613. (google.api.field_behavior) = REQUIRED,
  1614. (google.api.resource_reference) = {
  1615. type: "analyticsadmin.googleapis.com/DisplayVideo360AdvertiserLink"
  1616. }
  1617. ];
  1618. }
  1619. // Request message for UpdateDisplayVideo360AdvertiserLink RPC.
  1620. message UpdateDisplayVideo360AdvertiserLinkRequest {
  1621. // The DisplayVideo360AdvertiserLink to update
  1622. DisplayVideo360AdvertiserLink display_video_360_advertiser_link = 1;
  1623. // Required. The list of fields to be updated. Omitted fields will not be updated.
  1624. // To replace the entire entity, use one path with the string "*" to match
  1625. // all fields.
  1626. google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
  1627. }
  1628. // Request message for GetDisplayVideo360AdvertiserLinkProposal RPC.
  1629. message GetDisplayVideo360AdvertiserLinkProposalRequest {
  1630. // Required. The name of the DisplayVideo360AdvertiserLinkProposal to get.
  1631. // Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678
  1632. string name = 1 [
  1633. (google.api.field_behavior) = REQUIRED,
  1634. (google.api.resource_reference) = {
  1635. type: "analyticsadmin.googleapis.com/DisplayVideo360AdvertiserLinkProposal"
  1636. }
  1637. ];
  1638. }
  1639. // Request message for ListDisplayVideo360AdvertiserLinkProposals RPC.
  1640. message ListDisplayVideo360AdvertiserLinkProposalsRequest {
  1641. // Required. Example format: properties/1234
  1642. string parent = 1 [
  1643. (google.api.field_behavior) = REQUIRED,
  1644. (google.api.resource_reference) = {
  1645. child_type: "analyticsadmin.googleapis.com/DisplayVideo360AdvertiserLinkProposal"
  1646. }
  1647. ];
  1648. // The maximum number of resources to return.
  1649. // If unspecified, at most 50 resources will be returned.
  1650. // The maximum value is 200 (higher values will be coerced to the maximum).
  1651. int32 page_size = 2;
  1652. // A page token, received from a previous
  1653. // `ListDisplayVideo360AdvertiserLinkProposals` call. Provide this to retrieve
  1654. // the subsequent page.
  1655. //
  1656. // When paginating, all other parameters provided to
  1657. // `ListDisplayVideo360AdvertiserLinkProposals` must match the call that
  1658. // provided the page token.
  1659. string page_token = 3;
  1660. }
  1661. // Response message for ListDisplayVideo360AdvertiserLinkProposals RPC.
  1662. message ListDisplayVideo360AdvertiserLinkProposalsResponse {
  1663. // List of DisplayVideo360AdvertiserLinkProposals.
  1664. repeated DisplayVideo360AdvertiserLinkProposal display_video_360_advertiser_link_proposals = 1;
  1665. // A token, which can be sent as `page_token` to retrieve the next page.
  1666. // If this field is omitted, there are no subsequent pages.
  1667. string next_page_token = 2;
  1668. }
  1669. // Request message for CreateDisplayVideo360AdvertiserLinkProposal RPC.
  1670. message CreateDisplayVideo360AdvertiserLinkProposalRequest {
  1671. // Required. Example format: properties/1234
  1672. string parent = 1 [
  1673. (google.api.field_behavior) = REQUIRED,
  1674. (google.api.resource_reference) = {
  1675. child_type: "analyticsadmin.googleapis.com/DisplayVideo360AdvertiserLinkProposal"
  1676. }
  1677. ];
  1678. // Required. The DisplayVideo360AdvertiserLinkProposal to create.
  1679. DisplayVideo360AdvertiserLinkProposal display_video_360_advertiser_link_proposal = 2 [(google.api.field_behavior) = REQUIRED];
  1680. }
  1681. // Request message for DeleteDisplayVideo360AdvertiserLinkProposal RPC.
  1682. message DeleteDisplayVideo360AdvertiserLinkProposalRequest {
  1683. // Required. The name of the DisplayVideo360AdvertiserLinkProposal to delete.
  1684. // Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678
  1685. string name = 1 [
  1686. (google.api.field_behavior) = REQUIRED,
  1687. (google.api.resource_reference) = {
  1688. type: "analyticsadmin.googleapis.com/DisplayVideo360AdvertiserLinkProposal"
  1689. }
  1690. ];
  1691. }
  1692. // Request message for ApproveDisplayVideo360AdvertiserLinkProposal RPC.
  1693. message ApproveDisplayVideo360AdvertiserLinkProposalRequest {
  1694. // Required. The name of the DisplayVideo360AdvertiserLinkProposal to approve.
  1695. // Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678
  1696. string name = 1 [
  1697. (google.api.field_behavior) = REQUIRED,
  1698. (google.api.resource_reference) = {
  1699. type: "analyticsadmin.googleapis.com/DisplayVideo360AdvertiserLinkProposal"
  1700. }
  1701. ];
  1702. }
  1703. // Response message for ApproveDisplayVideo360AdvertiserLinkProposal RPC.
  1704. message ApproveDisplayVideo360AdvertiserLinkProposalResponse {
  1705. // The DisplayVideo360AdvertiserLink created as a result of approving the
  1706. // proposal.
  1707. DisplayVideo360AdvertiserLink display_video_360_advertiser_link = 1;
  1708. }
  1709. // Request message for CancelDisplayVideo360AdvertiserLinkProposal RPC.
  1710. message CancelDisplayVideo360AdvertiserLinkProposalRequest {
  1711. // Required. The name of the DisplayVideo360AdvertiserLinkProposal to cancel.
  1712. // Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678
  1713. string name = 1 [
  1714. (google.api.field_behavior) = REQUIRED,
  1715. (google.api.resource_reference) = {
  1716. type: "analyticsadmin.googleapis.com/DisplayVideo360AdvertiserLinkProposal"
  1717. }
  1718. ];
  1719. }
  1720. // Request message for CreateCustomDimension RPC.
  1721. message CreateCustomDimensionRequest {
  1722. // Required. Example format: properties/1234
  1723. string parent = 1 [
  1724. (google.api.field_behavior) = REQUIRED,
  1725. (google.api.resource_reference) = {
  1726. child_type: "analyticsadmin.googleapis.com/CustomDimension"
  1727. }
  1728. ];
  1729. // Required. The CustomDimension to create.
  1730. CustomDimension custom_dimension = 2 [(google.api.field_behavior) = REQUIRED];
  1731. }
  1732. // Request message for UpdateCustomDimension RPC.
  1733. message UpdateCustomDimensionRequest {
  1734. // The CustomDimension to update
  1735. CustomDimension custom_dimension = 1;
  1736. // Required. The list of fields to be updated. Omitted fields will not be updated.
  1737. // To replace the entire entity, use one path with the string "*" to match
  1738. // all fields.
  1739. google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
  1740. }
  1741. // Request message for ListCustomDimensions RPC.
  1742. message ListCustomDimensionsRequest {
  1743. // Required. Example format: properties/1234
  1744. string parent = 1 [
  1745. (google.api.field_behavior) = REQUIRED,
  1746. (google.api.resource_reference) = {
  1747. child_type: "analyticsadmin.googleapis.com/CustomDimension"
  1748. }
  1749. ];
  1750. // The maximum number of resources to return.
  1751. // If unspecified, at most 50 resources will be returned.
  1752. // The maximum value is 200 (higher values will be coerced to the maximum).
  1753. int32 page_size = 2;
  1754. // A page token, received from a previous `ListCustomDimensions` call.
  1755. // Provide this to retrieve the subsequent page.
  1756. //
  1757. // When paginating, all other parameters provided to `ListCustomDimensions`
  1758. // must match the call that provided the page token.
  1759. string page_token = 3;
  1760. }
  1761. // Response message for ListCustomDimensions RPC.
  1762. message ListCustomDimensionsResponse {
  1763. // List of CustomDimensions.
  1764. repeated CustomDimension custom_dimensions = 1;
  1765. // A token, which can be sent as `page_token` to retrieve the next page.
  1766. // If this field is omitted, there are no subsequent pages.
  1767. string next_page_token = 2;
  1768. }
  1769. // Request message for ArchiveCustomDimension RPC.
  1770. message ArchiveCustomDimensionRequest {
  1771. // Required. The name of the CustomDimension to archive.
  1772. // Example format: properties/1234/customDimensions/5678
  1773. string name = 1 [
  1774. (google.api.field_behavior) = REQUIRED,
  1775. (google.api.resource_reference) = {
  1776. type: "analyticsadmin.googleapis.com/CustomDimension"
  1777. }
  1778. ];
  1779. }
  1780. // Request message for GetCustomDimension RPC.
  1781. message GetCustomDimensionRequest {
  1782. // Required. The name of the CustomDimension to get.
  1783. // Example format: properties/1234/customDimensions/5678
  1784. string name = 1 [
  1785. (google.api.field_behavior) = REQUIRED,
  1786. (google.api.resource_reference) = {
  1787. type: "analyticsadmin.googleapis.com/CustomDimension"
  1788. }
  1789. ];
  1790. }
  1791. // Request message for CreateCustomMetric RPC.
  1792. message CreateCustomMetricRequest {
  1793. // Required. Example format: properties/1234
  1794. string parent = 1 [
  1795. (google.api.field_behavior) = REQUIRED,
  1796. (google.api.resource_reference) = {
  1797. child_type: "analyticsadmin.googleapis.com/CustomMetric"
  1798. }
  1799. ];
  1800. // Required. The CustomMetric to create.
  1801. CustomMetric custom_metric = 2 [(google.api.field_behavior) = REQUIRED];
  1802. }
  1803. // Request message for UpdateCustomMetric RPC.
  1804. message UpdateCustomMetricRequest {
  1805. // The CustomMetric to update
  1806. CustomMetric custom_metric = 1;
  1807. // Required. The list of fields to be updated. Omitted fields will not be updated.
  1808. // To replace the entire entity, use one path with the string "*" to match
  1809. // all fields.
  1810. google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
  1811. }
  1812. // Request message for ListCustomMetrics RPC.
  1813. message ListCustomMetricsRequest {
  1814. // Required. Example format: properties/1234
  1815. string parent = 1 [
  1816. (google.api.field_behavior) = REQUIRED,
  1817. (google.api.resource_reference) = {
  1818. child_type: "analyticsadmin.googleapis.com/CustomMetric"
  1819. }
  1820. ];
  1821. // The maximum number of resources to return.
  1822. // If unspecified, at most 50 resources will be returned.
  1823. // The maximum value is 200 (higher values will be coerced to the maximum).
  1824. int32 page_size = 2;
  1825. // A page token, received from a previous `ListCustomMetrics` call.
  1826. // Provide this to retrieve the subsequent page.
  1827. //
  1828. // When paginating, all other parameters provided to `ListCustomMetrics` must
  1829. // match the call that provided the page token.
  1830. string page_token = 3;
  1831. }
  1832. // Response message for ListCustomMetrics RPC.
  1833. message ListCustomMetricsResponse {
  1834. // List of CustomMetrics.
  1835. repeated CustomMetric custom_metrics = 1;
  1836. // A token, which can be sent as `page_token` to retrieve the next page.
  1837. // If this field is omitted, there are no subsequent pages.
  1838. string next_page_token = 2;
  1839. }
  1840. // Request message for ArchiveCustomMetric RPC.
  1841. message ArchiveCustomMetricRequest {
  1842. // Required. The name of the CustomMetric to archive.
  1843. // Example format: properties/1234/customMetrics/5678
  1844. string name = 1 [
  1845. (google.api.field_behavior) = REQUIRED,
  1846. (google.api.resource_reference) = {
  1847. type: "analyticsadmin.googleapis.com/CustomMetric"
  1848. }
  1849. ];
  1850. }
  1851. // Request message for GetCustomMetric RPC.
  1852. message GetCustomMetricRequest {
  1853. // Required. The name of the CustomMetric to get.
  1854. // Example format: properties/1234/customMetrics/5678
  1855. string name = 1 [
  1856. (google.api.field_behavior) = REQUIRED,
  1857. (google.api.resource_reference) = {
  1858. type: "analyticsadmin.googleapis.com/CustomMetric"
  1859. }
  1860. ];
  1861. }
  1862. // Request message for GetDataRetentionSettings RPC.
  1863. message GetDataRetentionSettingsRequest {
  1864. // Required. The name of the settings to lookup.
  1865. // Format:
  1866. // properties/{property}/dataRetentionSettings
  1867. // Example: "properties/1000/dataRetentionSettings"
  1868. string name = 1 [
  1869. (google.api.field_behavior) = REQUIRED,
  1870. (google.api.resource_reference) = {
  1871. type: "analyticsadmin.googleapis.com/DataRetentionSettings"
  1872. }
  1873. ];
  1874. }
  1875. // Request message for UpdateDataRetentionSettings RPC.
  1876. message UpdateDataRetentionSettingsRequest {
  1877. // Required. The settings to update.
  1878. // The `name` field is used to identify the settings to be updated.
  1879. DataRetentionSettings data_retention_settings = 1 [(google.api.field_behavior) = REQUIRED];
  1880. // Required. The list of fields to be updated. Field names must be in snake case
  1881. // (e.g., "field_to_update"). Omitted fields will not be updated. To replace
  1882. // the entire entity, use one path with the string "*" to match all fields.
  1883. google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
  1884. }
  1885. // Request message for CreateDataStream RPC.
  1886. message CreateDataStreamRequest {
  1887. // Required. Example format: properties/1234
  1888. string parent = 1 [
  1889. (google.api.field_behavior) = REQUIRED,
  1890. (google.api.resource_reference) = {
  1891. child_type: "analyticsadmin.googleapis.com/DataStream"
  1892. }
  1893. ];
  1894. // Required. The DataStream to create.
  1895. DataStream data_stream = 2 [(google.api.field_behavior) = REQUIRED];
  1896. }
  1897. // Request message for DeleteDataStream RPC.
  1898. message DeleteDataStreamRequest {
  1899. // Required. The name of the DataStream to delete.
  1900. // Example format: properties/1234/dataStreams/5678
  1901. string name = 1 [
  1902. (google.api.field_behavior) = REQUIRED,
  1903. (google.api.resource_reference) = {
  1904. type: "analyticsadmin.googleapis.com/DataStream"
  1905. }
  1906. ];
  1907. }
  1908. // Request message for UpdateDataStream RPC.
  1909. message UpdateDataStreamRequest {
  1910. // The DataStream to update
  1911. DataStream data_stream = 1;
  1912. // Required. The list of fields to be updated. Omitted fields will not be updated.
  1913. // To replace the entire entity, use one path with the string "*" to match
  1914. // all fields.
  1915. google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
  1916. }
  1917. // Request message for ListDataStreams RPC.
  1918. message ListDataStreamsRequest {
  1919. // Required. Example format: properties/1234
  1920. string parent = 1 [
  1921. (google.api.field_behavior) = REQUIRED,
  1922. (google.api.resource_reference) = {
  1923. child_type: "analyticsadmin.googleapis.com/DataStream"
  1924. }
  1925. ];
  1926. // The maximum number of resources to return.
  1927. // If unspecified, at most 50 resources will be returned.
  1928. // The maximum value is 200 (higher values will be coerced to the maximum).
  1929. int32 page_size = 2;
  1930. // A page token, received from a previous `ListDataStreams` call.
  1931. // Provide this to retrieve the subsequent page.
  1932. //
  1933. // When paginating, all other parameters provided to `ListDataStreams` must
  1934. // match the call that provided the page token.
  1935. string page_token = 3;
  1936. }
  1937. // Response message for ListDataStreams RPC.
  1938. message ListDataStreamsResponse {
  1939. // List of DataStreams.
  1940. repeated DataStream data_streams = 1;
  1941. // A token, which can be sent as `page_token` to retrieve the next page.
  1942. // If this field is omitted, there are no subsequent pages.
  1943. string next_page_token = 2;
  1944. }
  1945. // Request message for GetDataStream RPC.
  1946. message GetDataStreamRequest {
  1947. // Required. The name of the DataStream to get.
  1948. // Example format: properties/1234/dataStreams/5678
  1949. string name = 1 [
  1950. (google.api.field_behavior) = REQUIRED,
  1951. (google.api.resource_reference) = {
  1952. type: "analyticsadmin.googleapis.com/DataStream"
  1953. }
  1954. ];
  1955. }
  1956. // Request message for GetAudience RPC.
  1957. message GetAudienceRequest {
  1958. // Required. The name of the Audience to get.
  1959. // Example format: properties/1234/audiences/5678
  1960. string name = 1 [
  1961. (google.api.field_behavior) = REQUIRED,
  1962. (google.api.resource_reference) = {
  1963. type: "analyticsadmin.googleapis.com/Audience"
  1964. }
  1965. ];
  1966. }
  1967. // Request message for ListAudiences RPC.
  1968. message ListAudiencesRequest {
  1969. // Required. Example format: properties/1234
  1970. string parent = 1 [
  1971. (google.api.field_behavior) = REQUIRED,
  1972. (google.api.resource_reference) = {
  1973. child_type: "analyticsadmin.googleapis.com/Audience"
  1974. }
  1975. ];
  1976. // The maximum number of resources to return.
  1977. // If unspecified, at most 50 resources will be returned.
  1978. // The maximum value is 200 (higher values will be coerced to the maximum).
  1979. int32 page_size = 2;
  1980. // A page token, received from a previous `ListAudiences` call. Provide this
  1981. // to retrieve the subsequent page.
  1982. //
  1983. // When paginating, all other parameters provided to `ListAudiences` must
  1984. // match the call that provided the page token.
  1985. string page_token = 3;
  1986. }
  1987. // Response message for ListAudiences RPC.
  1988. message ListAudiencesResponse {
  1989. // List of Audiences.
  1990. repeated Audience audiences = 1;
  1991. // A token, which can be sent as `page_token` to retrieve the next page.
  1992. // If this field is omitted, there are no subsequent pages.
  1993. string next_page_token = 2;
  1994. }
  1995. // Request message for CreateAudience RPC.
  1996. message CreateAudienceRequest {
  1997. // Required. Example format: properties/1234
  1998. string parent = 1 [
  1999. (google.api.field_behavior) = REQUIRED,
  2000. (google.api.resource_reference) = {
  2001. child_type: "analyticsadmin.googleapis.com/Audience"
  2002. }
  2003. ];
  2004. // Required. The audience to create.
  2005. Audience audience = 2 [(google.api.field_behavior) = REQUIRED];
  2006. }
  2007. // Request message for UpdateAudience RPC.
  2008. message UpdateAudienceRequest {
  2009. // Required. The audience to update.
  2010. // The audience's `name` field is used to identify the audience to be updated.
  2011. Audience audience = 1 [(google.api.field_behavior) = REQUIRED];
  2012. // Required. The list of fields to be updated. Field names must be in snake case
  2013. // (e.g., "field_to_update"). Omitted fields will not be updated. To replace
  2014. // the entire entity, use one path with the string "*" to match all fields.
  2015. google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
  2016. }
  2017. // Request message for ArchiveAudience RPC.
  2018. message ArchiveAudienceRequest {
  2019. // Required. Example format: properties/1234/audiences/5678
  2020. string name = 1 [
  2021. (google.api.field_behavior) = REQUIRED,
  2022. (google.api.resource_reference) = {
  2023. child_type: "analyticsadmin.googleapis.com/Audience"
  2024. }
  2025. ];
  2026. }
  2027. // Request message for GetAttributionSettings RPC.
  2028. message GetAttributionSettingsRequest {
  2029. // Required. The name of the attribution settings to retrieve.
  2030. // Format: properties/{property}/attributionSettings
  2031. string name = 1 [
  2032. (google.api.field_behavior) = REQUIRED,
  2033. (google.api.resource_reference) = {
  2034. type: "analyticsadmin.googleapis.com/AttributionSettings"
  2035. }
  2036. ];
  2037. }
  2038. // Request message for UpdateAttributionSettings RPC
  2039. message UpdateAttributionSettingsRequest {
  2040. // Required. The attribution settings to update.
  2041. // The `name` field is used to identify the settings to be updated.
  2042. AttributionSettings attribution_settings = 1 [(google.api.field_behavior) = REQUIRED];
  2043. // Required. The list of fields to be updated. Field names must be in snake case
  2044. // (e.g., "field_to_update"). Omitted fields will not be updated. To replace
  2045. // the entire entity, use one path with the string "*" to match all fields.
  2046. google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
  2047. }