Google Ads Links: list

ต้องมีการให้สิทธิ์

แสดงรายการลิงก์ webProperty-Google Ads สำหรับผลิตภัณฑ์และบริการบนอินเทอร์เน็ตหนึ่งๆ ลองใช้เลยหรือดูตัวอย่าง

ส่งคำขอ

คำขอ HTTP

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

พารามิเตอร์

ชื่อพารามิเตอร์	ค่า	คำอธิบาย
พารามิเตอร์เส้นทาง
accountId	string	รหัสของบัญชีที่มีผลิตภัณฑ์และบริการบนอินเทอร์เน็ตนั้นอยู่
webPropertyId	string	รหัสเว็บพร็อพเพอร์ตี้สำหรับดึงข้อมูลลิงก์ Google Ads
พารามิเตอร์การค้นหาที่ไม่บังคับ
max-results	integer	จำนวนลิงก์ webProperty-Google Ads สูงสุดที่จะรวมไว้ในคำตอบนี้
start-index	integer	ดัชนีของ webProperty-Google Ads แรกที่ดึงมา ใช้พารามิเตอร์นี้เป็นกลไกการใส่เลขหน้าร่วมกับพารามิเตอร์ 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
  ]
}

ชื่อพร็อพเพอร์ตี้	ค่า	คำอธิบาย	Notes
kind	string	ประเภทคอลเล็กชัน
totalResults	integer	จำนวนผลลัพธ์ทั้งหมดสำหรับข้อความค้นหา โดยไม่คำนึงถึงจำนวนผลลัพธ์ในการตอบกลับ
startIndex	integer	ดัชนีเริ่มต้นของรายการ ซึ่งจะเป็น 1 โดยค่าเริ่มต้น หรือระบุโดยพารามิเตอร์การค้นหาของดัชนีเริ่มต้น
itemsPerPage	integer	จำนวนรายการสูงสุดที่การตอบกลับมีได้ โดยไม่คำนึงถึงจำนวนรายการจริงที่ส่งกลับมา ค่าอยู่ในช่วง 1 ถึง 1000 โดยมีค่า 1000 โดยค่าเริ่มต้น หรือมีการระบุโดยพารามิเตอร์การค้นหาผลลัพธ์สูงสุด
previousLink	string	ลิงก์ก่อนหน้าของคอลเล็กชันลิงก์ Google Ads นี้
nextLink	string	ลิงก์ถัดไปของคอลเล็กชันลิงก์ Google Ads นี้
items[]	list	รายการลิงก์ Google Ads ของบุคคล

ตัวอย่าง

หมายเหตุ: ตัวอย่างโค้ดที่มีสำหรับวิธีการนี้ไม่ได้แสดงถึงภาษาโปรแกรมที่รองรับทั้งหมด (ดูรายการภาษาที่รองรับได้ในหน้าไลบรารีของไคลเอ็นต์)

Java

ใช้ไลบรารีของไคลเอ็นต์ Java

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

/*
 * Example #1:
 * Requests a list of all Google Ads 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 Google Ads 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 Google Ads Links Developer Guide for details.
 */

/**
 * Example #1:
 * Requests a list of all Google Ads 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 Google Ads 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 Google Ads Links Developer Guide for details.

# Example #1:
# Requests a list of all Google Ads 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 Google Ads 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 Google Ads Links Developer Guide for details.
 */

/*
 * Example 1:
 * Requests a list of all Google Ads 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 Google Ads 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);
      }
    }
  }
}

ลองใช้เลย

ใช้ API Explorer ด้านล่างเพื่อเรียกใช้เมธอดนี้ในข้อมูลสดและดูการตอบสนอง หรือลองใช้เครื่องมือสำรวจแบบสแตนด์อโลน