AdWords リンク: list

承認が必要です

指定されたウェブ プロパティの、ウェブ プロパティと·AdWords のリンクを一覧表示します。 こちらから今すぐお試しいただけます。または、をご覧ください。

リクエスト

HTTP リクエスト

GET https://www.googleapis.com/analytics/v3/management/accounts/accountId/webproperties/webPropertyId/entityAdWordsLinks

パラメータ

パラメータ名 説明
パスパラメータ
accountId string 指定したウェブ プロパティが属するアカウントの ID。
webPropertyId string AdWords リンクを取得するウェブ プロパティの ID。
省略可能なクエリ パラメータ
max-results integer このレスポンスに含める、ウェブ プロパティと AdWords のリンクの最大数。
start-index integer 最初に取得する、ウェブ プロパティと AdWords のリンクのインデックス。このパラメータは、max-results パラメータとともに改ページ メカニズムとして使用します。

承認

このリクエストは、少なくとも以下のスコープの 1 つによって承認される必要があります(詳細については、認証と承認に関する記事をご覧ください)。

スコープ
https://www.googleapis.com/auth/analytics.edit
https://www.googleapis.com/auth/analytics.readonly

リクエスト本文

このメソッドをリクエストの本文に含めないでください。

レスポンス

成功すると、このメソッドは次の構造を含むレスポンスの本文を返します。

{
  "kind": "analytics#entityAdWordsLinks",
  "totalResults": integer,
  "startIndex": integer,
  "itemsPerPage": integer,
  "previousLink": string,
  "nextLink": string,
  "items": [
    management.webPropertyAdWordsLinks Resource
  ]
}
プロパティ名 説明 備考
kind string コレクション タイプ。
totalResults integer クエリに対する結果の合計数。レスポンス内の結果の数とは関係ありません。
startIndex integer エントリの開始インデックス。デフォルトでは 1 で、それ以外の場合は start-index クエリ パラメータに指定された数になります。
itemsPerPage integer レスポンスに含めることができるエントリの最大数。実際に返されたエントリの数とは関係ありません。値の範囲は 1 から 1,000 です。デフォルトでは 1,000 で、それ以外の場合は max-results クエリ パラメータで指定された数になります。
items[] list エンティティと AdWords のリンクのリスト。

注: このメソッドで使用可能なコード例では、サポートされているプログラミング言語すべての例を示しているわけではありません(サポートされている言語の一覧については、クライアント ライブラリ ページをご覧ください)。

Java

Java クライアント ライブラリを使用します。

/*
 * Note: This code assumes you have an authorized Analytics service object.
 * See the AdWords Links Developer Guide for details.
 */

/*
 * Example #1:
 * Requests a list of all AdWords links for the authorized user.
 */
try {
  EntityAdWordsLinks adWordsLinks = analytics.management().
      webPropertyAdWordsLinks().list("123456", "UA-123456-1").execute();
} catch (GoogleJsonResponseException e) {
  System.err.println("There was a service error: "
      + e.getDetails().getCode() + " : "
      + e.getDetails().getMessage());
}

/*
 * Example 2:
 * The results of the list method are stored in the adWordsLinks object.
 * The following code shows how to iterate through them.
 */
for (EntityAdWordsLink link : adWordsLinks.getItems()) {
  System.out.println("Link Id = " + link.getId());
  System.out.println("Link Kind = " + link.getKind());
  System.out.println("Link Name = " + link.getName());

  // Get the web property reference from the entity.
  WebPropertyRef property  = link.getEntity().getWebPropertyRef();
  System.out.println("Property Id = " + property.getId());
  System.out.println("Property Kind = " + property.getKind());
  System.out.println("Property Name = " + property.getName());
  System.out.println("Property Account Id = " + property.getAccountId());

  // Get the AdWords accounts.
  List<AdWordsAccount> adWordsAccounts = link.getAdWordsAccounts();
  for (AdWordsAccount account : adWordsAccounts) {
    System.out.println("Account Kind = " + account.getKind());
    System.out.println("Account Id = " + account.getCustomerId());
    System.out.println("Auto Tagging Enabled = " + account.getAutoTaggingEnabled());
  }
}

PHP

PHP クライアント ライブラリを使用します。

/**
 * Note: This code assumes you have an authorized Analytics service object.
 * See the AdWords Links Developer Guide for details.
 */

/**
 * Example #1:
 * Requests a list of all AdWords links for the authorized user.
 */
try {
  $adWordsLinks = $analytics->management_webPropertyAdWordsLinks
      ->listManagementwebPropertyAdWordsLinks('123456', 'UA-123456-1');

} catch (apiServiceException $e) {
  print 'There was an Analytics API service error '
      . $e->getCode() . ':' . $e->getMessage();

} catch (apiException $e) {
  print 'There was a general API error '
      . $e->getCode() . ':' . $e->getMessage();
}

/**
 * Example #2:
 * The results of the list method are stored in the adWordsLinks object.
 * The following code shows how to iterate through them.
 */
foreach ($adWordsLinks->getItems() as $link) {
  $html = <<<HTML
<pre>
Link Id = {$link->getId()}
Link Kind = {$link->getKind()}
Link Name = {$link->getName()}

HTML;

  // Get the web property reference from the entity.
  $property = $link->getEntity()->getWebPropertyRef();
  $html = <<<HTML
Property Id = {$property->getId()}
Property Kind = {$property->getKind()}
Property Name = {$property->getName()}
Property Account Id = {$property->getAccountId()}

HTML;

  // Get the AdWords accounts.
  foreach ($link->getAdWordsAccounts as $account) {
    $html = <<<HTML
Account Kind = {$account->getKind()}
Account Id = {$account->getCustomerId()}
Auto Tagging Enabled = {$account->getAutoTaggingEnabled()}
HTML;
  }

  $html .= '</pre>';
  print $html;
}

Python

Python クライアント ライブラリを使用します。

# Note: This code assumes you have an authorized Analytics service object.
# See the AdWords Links Developer Guide for details.

# Example #1:
# Requests a list of all AdWords links for the authorized user.
try:
  adWordsLinks = analytics.management().webPropertyAdWordsLinks().list(
      accountId='123456',
      webPropertyId='UA-123456-1'
  ).execute()

except TypeError, error:
  # Handle errors in constructing a query.
  print 'There was an error in constructing your query : %s' % error

except HttpError, error:
  # Handle API errors.
  print ('There was an API error : %s : %s' %
         (error.resp.status, error.resp.reason))

# Example #2:
# The results of the list method are stored in the adWordsLinks object.
# The following code shows how to iterate through them.
for link in adWordsLinks.get('items', []):
  print 'Link Id = %s' % link.get('id')
  print 'Link Kind = %s' % link.get('kind')
  print 'Link Name = %s' % link.get('name')

  # Get the property reference from the entity.
  property = link.get('entity', {}).get('webPropertyRef', {})
  print 'Property Id = %s' % property.get('id')
  print 'Property Kind = %s' % property.get('kind')
  print 'Property Name = %s' % property.get('name')
  print 'Property Account id = %s' % property.get('accountId')

  # Get the AdWords accounts.
  adWordsAccounts = link.get('adWordsAccounts', [])
  for account in adWordsAccounts:
    print 'Account Id = %s' % account.get('id')
    print 'Account Kind = %s' % account.get('kind')
    print 'Auto Tagging Enabled = %s' % account.get('autoTaggingEnabled')

JavaScript

JavaScript クライアント ライブラリを使用します。

/*
 * Note: This code assumes you have an authorized Analytics client object.
 * See the AdWords Links Developer Guide for details.
 */

/*
 * Example 1:
 * Requests a list of all AdWords links for the authorized user.
 */
function listAdWordsLinks() {
  var request = gapi.client.analytics.management.webPropertyAdWordsLinks.list({
    'accountId': '123456',
    'webPropertyId': 'UA-123456-1'
  });
  request.execute(printViews);
}

/*
 * Example 2:
 * The results of the list method are passed as the results object.
 * The following code shows how to iterate through them.
 */
function printViews(results) {
  if (results && !results.error) {
    var adWordsLinks = results.items;
    for (var i = 0, link; link = adWordsLinks[i]; i++) {

      console.log('Link Id: ' + link.id);
      console.log('Link Kind: ' + link.kind);
      console.log('Link Name: ' + link.name);

      // Get the property reference from the entity.
      var property = link.entity.webPropertyRef;
      console.log('Property Id: ' + property.id);
      console.log('Property Kind: ' + property.kind);
      console.log('Property Name: ' + property.name);
      console.log('Property Account id: ' + property.accountId);

      // Get the AdWords accounts.
      var adWordsAccounts = link.adWordsAccounts;
      for (var j = 0, account; account = adWordsAccounts[j]; j++) {
        console.log('Account Id: ' + account.customerId);
        console.log('Account Kind: ' + account.kind);
        console.log('Auto Tagging Enabled: ' + account.autoTaggingEnabled);
      }
    }
  }
}

試してみる

リアルタイムのデータでこのメソッドを呼び出してレスポンスを確認するには、以下の APIs Explorer か、 スタンドアロンの テストツール をご利用ください。