| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="analyticsadmin_v1alpha.html">Google Analytics Admin API</a> . <a href="analyticsadmin_v1alpha.properties.html">properties</a> . <a href="analyticsadmin_v1alpha.properties.firebaseLinks.html">firebaseLinks</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#close">close()</a></code></p> |
| 79 | <p class="firstline">Close httplib2 connections.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Creates a FirebaseLink. Properties can have at most one FirebaseLink.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Deletes a FirebaseLink on a property</p> |
| 86 | <p class="toc_element"> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 87 | <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 88 | <p class="firstline">Lists FirebaseLinks on a property. Properties can have at most one FirebaseLink.</p> |
| 89 | <p class="toc_element"> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 90 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 91 | <p class="firstline">Retrieves the next page of results.</p> |
| 92 | <p class="toc_element"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 93 | <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| 94 | <p class="firstline">Updates a FirebaseLink on a property</p> |
| 95 | <h3>Method Details</h3> |
| 96 | <div class="method"> |
| 97 | <code class="details" id="close">close()</code> |
| 98 | <pre>Close httplib2 connections.</pre> |
| 99 | </div> |
| 100 | |
| 101 | <div class="method"> |
| 102 | <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> |
| 103 | <pre>Creates a FirebaseLink. Properties can have at most one FirebaseLink. |
| 104 | |
| 105 | Args: |
| 106 | parent: string, Required. Format: properties/{property_id} Example: properties/1234 (required) |
| 107 | body: object, The request body. |
| 108 | The object takes the form of: |
| 109 | |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 110 | { # A link between an GA4 property and a Firebase project. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 111 | "createTime": "A String", # Output only. Time when this FirebaseLink was originally created. |
| 112 | "maximumUserAccess": "A String", # Maximum user access to the GA4 property allowed to admins of the linked Firebase project. |
| 113 | "name": "A String", # Output only. Example format: properties/1234/firebaseLinks/5678 |
| 114 | "project": "A String", # Immutable. Firebase project resource name. When creating a FirebaseLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, returned FirebaseLinks will always have a project_name that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234' |
| 115 | } |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 116 | |
| 117 | x__xgafv: string, V1 error format. |
| 118 | Allowed values |
| 119 | 1 - v1 error format |
| 120 | 2 - v2 error format |
| 121 | |
| 122 | Returns: |
| 123 | An object of the form: |
| 124 | |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 125 | { # A link between an GA4 property and a Firebase project. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 126 | "createTime": "A String", # Output only. Time when this FirebaseLink was originally created. |
| 127 | "maximumUserAccess": "A String", # Maximum user access to the GA4 property allowed to admins of the linked Firebase project. |
| 128 | "name": "A String", # Output only. Example format: properties/1234/firebaseLinks/5678 |
| 129 | "project": "A String", # Immutable. Firebase project resource name. When creating a FirebaseLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, returned FirebaseLinks will always have a project_name that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234' |
| 130 | }</pre> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 131 | </div> |
| 132 | |
| 133 | <div class="method"> |
| 134 | <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| 135 | <pre>Deletes a FirebaseLink on a property |
| 136 | |
| 137 | Args: |
| 138 | name: string, Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id} Example: properties/1234/firebaseLinks/5678 (required) |
| 139 | x__xgafv: string, V1 error format. |
| 140 | Allowed values |
| 141 | 1 - v1 error format |
| 142 | 2 - v2 error format |
| 143 | |
| 144 | Returns: |
| 145 | An object of the form: |
| 146 | |
| 147 | { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 148 | }</pre> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 149 | </div> |
| 150 | |
| 151 | <div class="method"> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 152 | <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 153 | <pre>Lists FirebaseLinks on a property. Properties can have at most one FirebaseLink. |
| 154 | |
| 155 | Args: |
| 156 | parent: string, Required. Format: properties/{property_id} Example: properties/1234 (required) |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 157 | pageSize: integer, The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) |
| 158 | pageToken: string, A page token, received from a previous `ListFirebaseLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListProperties` must match the call that provided the page token. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 159 | x__xgafv: string, V1 error format. |
| 160 | Allowed values |
| 161 | 1 - v1 error format |
| 162 | 2 - v2 error format |
| 163 | |
| 164 | Returns: |
| 165 | An object of the form: |
| 166 | |
| 167 | { # Response message for ListFirebaseLinks RPC |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 168 | "firebaseLinks": [ # List of FirebaseLinks. This will have at most one value. |
| 169 | { # A link between an GA4 property and a Firebase project. |
| 170 | "createTime": "A String", # Output only. Time when this FirebaseLink was originally created. |
| 171 | "maximumUserAccess": "A String", # Maximum user access to the GA4 property allowed to admins of the linked Firebase project. |
| 172 | "name": "A String", # Output only. Example format: properties/1234/firebaseLinks/5678 |
| 173 | "project": "A String", # Immutable. Firebase project resource name. When creating a FirebaseLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, returned FirebaseLinks will always have a project_name that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234' |
| 174 | }, |
| 175 | ], |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 176 | "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. Currently, Google Analytics supports only one FirebaseLink per property, so this will never be populated. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 177 | }</pre> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 178 | </div> |
| 179 | |
| 180 | <div class="method"> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 181 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 182 | <pre>Retrieves the next page of results. |
| 183 | |
| 184 | Args: |
| 185 | previous_request: The request for the previous page. (required) |
| 186 | previous_response: The response from the request for the previous page. (required) |
| 187 | |
| 188 | Returns: |
| 189 | A request object that you can call 'execute()' on to request the next |
| 190 | page. Returns None if there are no more items in the collection. |
| 191 | </pre> |
| 192 | </div> |
| 193 | |
| 194 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 195 | <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| 196 | <pre>Updates a FirebaseLink on a property |
| 197 | |
| 198 | Args: |
| 199 | name: string, Output only. Example format: properties/1234/firebaseLinks/5678 (required) |
| 200 | body: object, The request body. |
| 201 | The object takes the form of: |
| 202 | |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 203 | { # A link between an GA4 property and a Firebase project. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 204 | "createTime": "A String", # Output only. Time when this FirebaseLink was originally created. |
| 205 | "maximumUserAccess": "A String", # Maximum user access to the GA4 property allowed to admins of the linked Firebase project. |
| 206 | "name": "A String", # Output only. Example format: properties/1234/firebaseLinks/5678 |
| 207 | "project": "A String", # Immutable. Firebase project resource name. When creating a FirebaseLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, returned FirebaseLinks will always have a project_name that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234' |
| 208 | } |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 209 | |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 210 | updateMask: string, Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 211 | x__xgafv: string, V1 error format. |
| 212 | Allowed values |
| 213 | 1 - v1 error format |
| 214 | 2 - v2 error format |
| 215 | |
| 216 | Returns: |
| 217 | An object of the form: |
| 218 | |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 219 | { # A link between an GA4 property and a Firebase project. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 220 | "createTime": "A String", # Output only. Time when this FirebaseLink was originally created. |
| 221 | "maximumUserAccess": "A String", # Maximum user access to the GA4 property allowed to admins of the linked Firebase project. |
| 222 | "name": "A String", # Output only. Example format: properties/1234/firebaseLinks/5678 |
| 223 | "project": "A String", # Immutable. Firebase project resource name. When creating a FirebaseLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, returned FirebaseLinks will always have a project_name that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234' |
| 224 | }</pre> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 225 | </div> |
| 226 | |
| 227 | </body></html> |