| 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.googleAdsLinks.html">googleAdsLinks</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 GoogleAdsLink.</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 GoogleAdsLink on a property</p> |
| 86 | <p class="toc_element"> |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 87 | <code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 88 | <p class="firstline">Lists GoogleAdsLinks on a property.</p> |
| 89 | <p class="toc_element"> |
| 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"> |
| 93 | <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| 94 | <p class="firstline">Updates a GoogleAdsLink 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 GoogleAdsLink. |
| 104 | |
| 105 | Args: |
| 106 | parent: string, Required. Example format: 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 Google Ads account. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 111 | "parent": "A String", # Immutable. Format: properties/{propertyId} |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 112 | "createTime": "A String", # Output only. Time when this link was originally created. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 113 | "canManageClients": True or False, # Output only. If true, this link is for a Google Ads manager account. |
| 114 | "emailAddress": "A String", # Output only. Email address of the user that created the link. An empty string will be returned if the email address can't be retrieved. |
| 115 | "updateTime": "A String", # Output only. Time when this link was last updated. |
| 116 | "adsPersonalizationEnabled": True or False, # Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update it will be defaulted to true. |
| 117 | "customerId": "A String", # Immutable. Google Ads customer ID. |
| 118 | "name": "A String", # Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 119 | } |
| 120 | |
| 121 | x__xgafv: string, V1 error format. |
| 122 | Allowed values |
| 123 | 1 - v1 error format |
| 124 | 2 - v2 error format |
| 125 | |
| 126 | Returns: |
| 127 | An object of the form: |
| 128 | |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 129 | { # A link between an GA4 property and a Google Ads account. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 130 | "parent": "A String", # Immutable. Format: properties/{propertyId} |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 131 | "createTime": "A String", # Output only. Time when this link was originally created. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 132 | "canManageClients": True or False, # Output only. If true, this link is for a Google Ads manager account. |
| 133 | "emailAddress": "A String", # Output only. Email address of the user that created the link. An empty string will be returned if the email address can't be retrieved. |
| 134 | "updateTime": "A String", # Output only. Time when this link was last updated. |
| 135 | "adsPersonalizationEnabled": True or False, # Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update it will be defaulted to true. |
| 136 | "customerId": "A String", # Immutable. Google Ads customer ID. |
| 137 | "name": "A String", # Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 138 | }</pre> |
| 139 | </div> |
| 140 | |
| 141 | <div class="method"> |
| 142 | <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| 143 | <pre>Deletes a GoogleAdsLink on a property |
| 144 | |
| 145 | Args: |
| 146 | name: string, Required. Example format: properties/1234/googleAdsLinks/5678 (required) |
| 147 | x__xgafv: string, V1 error format. |
| 148 | Allowed values |
| 149 | 1 - v1 error format |
| 150 | 2 - v2 error format |
| 151 | |
| 152 | Returns: |
| 153 | An object of the form: |
| 154 | |
| 155 | { # 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 `{}`. |
| 156 | }</pre> |
| 157 | </div> |
| 158 | |
| 159 | <div class="method"> |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 160 | <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 161 | <pre>Lists GoogleAdsLinks on a property. |
| 162 | |
| 163 | Args: |
| 164 | parent: string, Required. Example format: properties/1234 (required) |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 165 | pageToken: string, A page token, received from a previous `ListGoogleAdsLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListGoogleAdsLinks` must match the call that provided the page token. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 166 | pageSize: integer, The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 167 | x__xgafv: string, V1 error format. |
| 168 | Allowed values |
| 169 | 1 - v1 error format |
| 170 | 2 - v2 error format |
| 171 | |
| 172 | Returns: |
| 173 | An object of the form: |
| 174 | |
| 175 | { # Response message for ListGoogleAdsLinks RPC. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -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. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 177 | "googleAdsLinks": [ # List of GoogleAdsLinks. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 178 | { # A link between an GA4 property and a Google Ads account. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 179 | "parent": "A String", # Immutable. Format: properties/{propertyId} |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 180 | "createTime": "A String", # Output only. Time when this link was originally created. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 181 | "canManageClients": True or False, # Output only. If true, this link is for a Google Ads manager account. |
| 182 | "emailAddress": "A String", # Output only. Email address of the user that created the link. An empty string will be returned if the email address can't be retrieved. |
| 183 | "updateTime": "A String", # Output only. Time when this link was last updated. |
| 184 | "adsPersonalizationEnabled": True or False, # Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update it will be defaulted to true. |
| 185 | "customerId": "A String", # Immutable. Google Ads customer ID. |
| 186 | "name": "A String", # Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 187 | }, |
| 188 | ], |
| 189 | }</pre> |
| 190 | </div> |
| 191 | |
| 192 | <div class="method"> |
| 193 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 194 | <pre>Retrieves the next page of results. |
| 195 | |
| 196 | Args: |
| 197 | previous_request: The request for the previous page. (required) |
| 198 | previous_response: The response from the request for the previous page. (required) |
| 199 | |
| 200 | Returns: |
| 201 | A request object that you can call 'execute()' on to request the next |
| 202 | page. Returns None if there are no more items in the collection. |
| 203 | </pre> |
| 204 | </div> |
| 205 | |
| 206 | <div class="method"> |
| 207 | <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| 208 | <pre>Updates a GoogleAdsLink on a property |
| 209 | |
| 210 | Args: |
| 211 | name: string, Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. (required) |
| 212 | body: object, The request body. |
| 213 | The object takes the form of: |
| 214 | |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 215 | { # A link between an GA4 property and a Google Ads account. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 216 | "parent": "A String", # Immutable. Format: properties/{propertyId} |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 217 | "createTime": "A String", # Output only. Time when this link was originally created. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 218 | "canManageClients": True or False, # Output only. If true, this link is for a Google Ads manager account. |
| 219 | "emailAddress": "A String", # Output only. Email address of the user that created the link. An empty string will be returned if the email address can't be retrieved. |
| 220 | "updateTime": "A String", # Output only. Time when this link was last updated. |
| 221 | "adsPersonalizationEnabled": True or False, # Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update it will be defaulted to true. |
| 222 | "customerId": "A String", # Immutable. Google Ads customer ID. |
| 223 | "name": "A String", # Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 224 | } |
| 225 | |
| 226 | updateMask: string, The list of fields to be updated. Omitted fields will not be updated. |
| 227 | x__xgafv: string, V1 error format. |
| 228 | Allowed values |
| 229 | 1 - v1 error format |
| 230 | 2 - v2 error format |
| 231 | |
| 232 | Returns: |
| 233 | An object of the form: |
| 234 | |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 235 | { # A link between an GA4 property and a Google Ads account. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 236 | "parent": "A String", # Immutable. Format: properties/{propertyId} |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 237 | "createTime": "A String", # Output only. Time when this link was originally created. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 238 | "canManageClients": True or False, # Output only. If true, this link is for a Google Ads manager account. |
| 239 | "emailAddress": "A String", # Output only. Email address of the user that created the link. An empty string will be returned if the email address can't be retrieved. |
| 240 | "updateTime": "A String", # Output only. Time when this link was last updated. |
| 241 | "adsPersonalizationEnabled": True or False, # Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update it will be defaulted to true. |
| 242 | "customerId": "A String", # Immutable. Google Ads customer ID. |
| 243 | "name": "A String", # Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 244 | }</pre> |
| 245 | </div> |
| 246 | |
| 247 | </body></html> |