/management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks

GET

Lists webProperty-Google Ads links for a given web property.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://analytics.googleapis.com/analytics/v3/management/accounts//webproperties//entityAdWordsLinks'

Response Example

{
    "items": [
        {
            "adWordsAccounts": [
                {
                    "autoTaggingEnabled": true,
                    "customerId": "string",
                    "kind": "analytics#adWordsAccount"
                }
            ],
            "entity": {
                "webPropertyRef": {
                    "accountId": "string",
                    "href": "string",
                    "id": "string",
                    "internalWebPropertyId": "string",
                    "kind": "analytics#webPropertyRef",
                    "name": "string"
                }
            },
            "id": "string",
            "kind": "analytics#entityAdWordsLink",
            "name": "string",
            "profileIds": [
                "string"
            ],
            "selfLink": "string"
        }
    ],
    "itemsPerPage": 0,
    "kind": "analytics#entityAdWordsLinks",
    "nextLink": "string",
    "previousLink": "string",
    "startIndex": 0,
    "totalResults": 0
}

Request

Path Params

accountId

string

required

ID of the account which the given web property belongs to.

webPropertyId

string

required

Web property ID to retrieve the Google Ads links for.

Query Params

max-results

integer

optional

The maximum number of webProperty-Google Ads links to include in this response.

start-index

integer

optional

An index of the first webProperty-Google Ads link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

Responses

🟢200Successful response

application/json

Body

An entity Google Ads link collection provides a list of GA-Google Ads links Each resource in this collection corresponds to a single link.

items

array[object (EntityAdWordsLink) {7}]

optional

A list of entity Google Ads links.

adWordsAccounts

array[object (AdWordsAccount) {3}]

optional

A list of Google Ads client accounts. These cannot be MCC accounts. This field is required when creating a Google Ads link. It cannot be empty.

entity

object

optional

Web property being linked.

string

optional

Entity Google Ads link ID

kind

string

optional

Resource type for entity Google Ads link.

Default:

analytics#entityAdWordsLink

name

string

optional

Name of the link. This field is required when creating a Google Ads link.

profileIds

array[string]

optional

IDs of linked Views (Profiles) represented as strings.

selfLink

string

optional

URL link for this Google Analytics - Google Ads link.

itemsPerPage

integer <int32>

optional

The maximum number of entries the response can contain, regardless of the actual number of entries returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.

kind

string

optional

Collection type.

Default:

analytics#entityAdWordsLinks

nextLink

string

optional

Next link for this Google Ads link collection.

previousLink

string

optional

Previous link for this Google Ads link collection.

startIndex

integer <int32>

optional

The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter.

totalResults

integer <int32>

optional

The total number of results for the query, regardless of the number of results in the response.

Modified at 2023-08-15 05:39:07

/management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}

/management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks