| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="analyticsadmin_v1alpha.html">Google Analytics Admin API</a> . <a href="analyticsadmin_v1alpha.properties.html">properties</a> . <a href="analyticsadmin_v1alpha.properties.searchAds360Links.html">searchAds360Links</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates a SearchAds360Link.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes a SearchAds360Link on a property.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Look up a single SearchAds360Link</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists all SearchAds360Links on a property.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next()</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Updates a SearchAds360Link on a property.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> |
| <pre>Creates a SearchAds360Link. |
| |
| Args: |
| parent: string, Required. Example format: properties/1234 (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A link between a Google Analytics property and a Search Ads 360 entity. |
| "adsPersonalizationEnabled": True or False, # Enables personalized advertising features with this integration. If this field is not set on create, it will be defaulted to true. |
| "advertiserDisplayName": "A String", # Output only. The display name of the Search Ads 360 Advertiser. Allows users to easily identify the linked resource. |
| "advertiserId": "A String", # Immutable. This field represents the Advertiser ID of the Search Ads 360 Advertiser. that has been linked. |
| "campaignDataSharingEnabled": True or False, # Immutable. Enables the import of campaign data from Search Ads 360 into the Google Analytics property. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true. |
| "costDataSharingEnabled": True or False, # Immutable. Enables the import of cost data from Search Ads 360 to the Google Analytics property. This can only be enabled if campaign_data_sharing_enabled is enabled. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true. |
| "name": "A String", # Output only. The resource name for this SearchAds360Link resource. Format: properties/{propertyId}/searchAds360Links/{linkId} Note: linkId is not the Search Ads 360 advertiser ID |
| "siteStatsSharingEnabled": True or False, # Enables export of site stats with this integration. If this field is not set on create, it will be defaulted to true. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A link between a Google Analytics property and a Search Ads 360 entity. |
| "adsPersonalizationEnabled": True or False, # Enables personalized advertising features with this integration. If this field is not set on create, it will be defaulted to true. |
| "advertiserDisplayName": "A String", # Output only. The display name of the Search Ads 360 Advertiser. Allows users to easily identify the linked resource. |
| "advertiserId": "A String", # Immutable. This field represents the Advertiser ID of the Search Ads 360 Advertiser. that has been linked. |
| "campaignDataSharingEnabled": True or False, # Immutable. Enables the import of campaign data from Search Ads 360 into the Google Analytics property. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true. |
| "costDataSharingEnabled": True or False, # Immutable. Enables the import of cost data from Search Ads 360 to the Google Analytics property. This can only be enabled if campaign_data_sharing_enabled is enabled. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true. |
| "name": "A String", # Output only. The resource name for this SearchAds360Link resource. Format: properties/{propertyId}/searchAds360Links/{linkId} Note: linkId is not the Search Ads 360 advertiser ID |
| "siteStatsSharingEnabled": True or False, # Enables export of site stats with this integration. If this field is not set on create, it will be defaulted to true. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| <pre>Deletes a SearchAds360Link on a property. |
| |
| Args: |
| name: string, Required. The name of the SearchAds360Link to delete. Example format: properties/1234/SearchAds360Links/5678 (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # 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); } |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>Look up a single SearchAds360Link |
| |
| Args: |
| name: string, Required. The name of the SearchAds360Link to get. Example format: properties/1234/SearchAds360Link/5678 (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A link between a Google Analytics property and a Search Ads 360 entity. |
| "adsPersonalizationEnabled": True or False, # Enables personalized advertising features with this integration. If this field is not set on create, it will be defaulted to true. |
| "advertiserDisplayName": "A String", # Output only. The display name of the Search Ads 360 Advertiser. Allows users to easily identify the linked resource. |
| "advertiserId": "A String", # Immutable. This field represents the Advertiser ID of the Search Ads 360 Advertiser. that has been linked. |
| "campaignDataSharingEnabled": True or False, # Immutable. Enables the import of campaign data from Search Ads 360 into the Google Analytics property. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true. |
| "costDataSharingEnabled": True or False, # Immutable. Enables the import of cost data from Search Ads 360 to the Google Analytics property. This can only be enabled if campaign_data_sharing_enabled is enabled. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true. |
| "name": "A String", # Output only. The resource name for this SearchAds360Link resource. Format: properties/{propertyId}/searchAds360Links/{linkId} Note: linkId is not the Search Ads 360 advertiser ID |
| "siteStatsSharingEnabled": True or False, # Enables export of site stats with this integration. If this field is not set on create, it will be defaulted to true. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>Lists all SearchAds360Links on a property. |
| |
| Args: |
| parent: string, Required. Example format: properties/1234 (required) |
| 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). |
| pageToken: string, A page token, received from a previous `ListSearchAds360Links` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSearchAds360Links` must match the call that provided the page token. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response message for ListSearchAds360Links RPC. |
| "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. |
| "searchAds360Links": [ # List of SearchAds360Links. |
| { # A link between a Google Analytics property and a Search Ads 360 entity. |
| "adsPersonalizationEnabled": True or False, # Enables personalized advertising features with this integration. If this field is not set on create, it will be defaulted to true. |
| "advertiserDisplayName": "A String", # Output only. The display name of the Search Ads 360 Advertiser. Allows users to easily identify the linked resource. |
| "advertiserId": "A String", # Immutable. This field represents the Advertiser ID of the Search Ads 360 Advertiser. that has been linked. |
| "campaignDataSharingEnabled": True or False, # Immutable. Enables the import of campaign data from Search Ads 360 into the Google Analytics property. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true. |
| "costDataSharingEnabled": True or False, # Immutable. Enables the import of cost data from Search Ads 360 to the Google Analytics property. This can only be enabled if campaign_data_sharing_enabled is enabled. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true. |
| "name": "A String", # Output only. The resource name for this SearchAds360Link resource. Format: properties/{propertyId}/searchAds360Links/{linkId} Note: linkId is not the Search Ads 360 advertiser ID |
| "siteStatsSharingEnabled": True or False, # Enables export of site stats with this integration. If this field is not set on create, it will be defaulted to true. |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next()</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| <pre>Updates a SearchAds360Link on a property. |
| |
| Args: |
| name: string, Output only. The resource name for this SearchAds360Link resource. Format: properties/{propertyId}/searchAds360Links/{linkId} Note: linkId is not the Search Ads 360 advertiser ID (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A link between a Google Analytics property and a Search Ads 360 entity. |
| "adsPersonalizationEnabled": True or False, # Enables personalized advertising features with this integration. If this field is not set on create, it will be defaulted to true. |
| "advertiserDisplayName": "A String", # Output only. The display name of the Search Ads 360 Advertiser. Allows users to easily identify the linked resource. |
| "advertiserId": "A String", # Immutable. This field represents the Advertiser ID of the Search Ads 360 Advertiser. that has been linked. |
| "campaignDataSharingEnabled": True or False, # Immutable. Enables the import of campaign data from Search Ads 360 into the Google Analytics property. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true. |
| "costDataSharingEnabled": True or False, # Immutable. Enables the import of cost data from Search Ads 360 to the Google Analytics property. This can only be enabled if campaign_data_sharing_enabled is enabled. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true. |
| "name": "A String", # Output only. The resource name for this SearchAds360Link resource. Format: properties/{propertyId}/searchAds360Links/{linkId} Note: linkId is not the Search Ads 360 advertiser ID |
| "siteStatsSharingEnabled": True or False, # Enables export of site stats with this integration. If this field is not set on create, it will be defaulted to true. |
| } |
| |
| updateMask: string, Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A link between a Google Analytics property and a Search Ads 360 entity. |
| "adsPersonalizationEnabled": True or False, # Enables personalized advertising features with this integration. If this field is not set on create, it will be defaulted to true. |
| "advertiserDisplayName": "A String", # Output only. The display name of the Search Ads 360 Advertiser. Allows users to easily identify the linked resource. |
| "advertiserId": "A String", # Immutable. This field represents the Advertiser ID of the Search Ads 360 Advertiser. that has been linked. |
| "campaignDataSharingEnabled": True or False, # Immutable. Enables the import of campaign data from Search Ads 360 into the Google Analytics property. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true. |
| "costDataSharingEnabled": True or False, # Immutable. Enables the import of cost data from Search Ads 360 to the Google Analytics property. This can only be enabled if campaign_data_sharing_enabled is enabled. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true. |
| "name": "A String", # Output only. The resource name for this SearchAds360Link resource. Format: properties/{propertyId}/searchAds360Links/{linkId} Note: linkId is not the Search Ads 360 advertiser ID |
| "siteStatsSharingEnabled": True or False, # Enables export of site stats with this integration. If this field is not set on create, it will be defaulted to true. |
| }</pre> |
| </div> |
| |
| </body></html> |
