Google Analytics Admin API . properties . googleAdsLinks

Instance Methods

close()

Close httplib2 connections.

create(parent, body=None, x__xgafv=None)

Creates a GoogleAdsLink.

delete(name, x__xgafv=None)

Deletes a GoogleAdsLink on a property

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Lists GoogleAdsLinks on a property.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates a GoogleAdsLink on a property

Method Details

close()
Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
Creates a GoogleAdsLink.

Args:
  parent: string, Required. Example format: properties/1234 (required)
  body: object, The request body.
    The object takes the form of:

{ # A link between a GA4 property and a Google Ads account.
  "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.
  "canManageClients": True or False, # Output only. If true, this link is for a Google Ads manager account.
  "createTime": "A String", # Output only. Time when this link was originally created.
  "creatorEmailAddress": "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.
  "customerId": "A String", # Immutable. Google Ads customer ID.
  "name": "A String", # Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.
  "updateTime": "A String", # Output only. Time when this link was last updated.
}

  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 GA4 property and a Google Ads account.
  "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.
  "canManageClients": True or False, # Output only. If true, this link is for a Google Ads manager account.
  "createTime": "A String", # Output only. Time when this link was originally created.
  "creatorEmailAddress": "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.
  "customerId": "A String", # Immutable. Google Ads customer ID.
  "name": "A String", # Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.
  "updateTime": "A String", # Output only. Time when this link was last updated.
}
delete(name, x__xgafv=None)
Deletes a GoogleAdsLink on a property

Args:
  name: string, Required. Example format: properties/1234/googleAdsLinks/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); } The JSON representation for `Empty` is empty JSON object `{}`.
}
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists GoogleAdsLinks 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 `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.
  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 ListGoogleAdsLinks RPC.
  "googleAdsLinks": [ # List of GoogleAdsLinks.
    { # A link between a GA4 property and a Google Ads account.
      "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.
      "canManageClients": True or False, # Output only. If true, this link is for a Google Ads manager account.
      "createTime": "A String", # Output only. Time when this link was originally created.
      "creatorEmailAddress": "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.
      "customerId": "A String", # Immutable. Google Ads customer ID.
      "name": "A String", # Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.
      "updateTime": "A String", # Output only. Time when this link was last updated.
    },
  ],
  "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.
}
list_next(previous_request, previous_response)
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.
    
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a GoogleAdsLink on a property

Args:
  name: string, Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. (required)
  body: object, The request body.
    The object takes the form of:

{ # A link between a GA4 property and a Google Ads account.
  "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.
  "canManageClients": True or False, # Output only. If true, this link is for a Google Ads manager account.
  "createTime": "A String", # Output only. Time when this link was originally created.
  "creatorEmailAddress": "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.
  "customerId": "A String", # Immutable. Google Ads customer ID.
  "name": "A String", # Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.
  "updateTime": "A String", # Output only. Time when this link was last updated.
}

  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.
  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 GA4 property and a Google Ads account.
  "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.
  "canManageClients": True or False, # Output only. If true, this link is for a Google Ads manager account.
  "createTime": "A String", # Output only. Time when this link was originally created.
  "creatorEmailAddress": "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.
  "customerId": "A String", # Immutable. Google Ads customer ID.
  "name": "A String", # Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.
  "updateTime": "A String", # Output only. Time when this link was last updated.
}