ตัวอย่าง

คู่มือนี้มีตัวอย่างการเรียกใช้ปลายทาง REST โดยตรงโดยไม่ต้องใช้ไลบรารีไคลเอ็นต์

ข้อกำหนดเบื้องต้น

ตัวอย่างทั้งหมดที่แสดงที่นี่มีไว้เพื่อคัดลอกและวางลงในเชลล์ bash โดยใช้คำสั่ง curl

นอกจากนี้ คุณยังต้องมีโทเค็นของนักพัฒนาซอฟต์แวร์ สิทธิ์เข้าถึงบัญชีทดสอบ และบัญชีดูแลจัดการ Google Ads ที่มีบัญชีลูกค้าอย่างน้อย 1 บัญชี

ตัวแปรสภาพแวดล้อม

ป้อนข้อมูลเข้าสู่ระบบและรหัสบัญชีตามที่แสดง จากนั้นคัดลอกและวางลงในเทอร์มินัลเพื่อกำหนดค่าตัวแปรสภาพแวดล้อมที่ใช้ในตัวอย่างถัดไป คู่มือการให้สิทธิ์มีวิธีการสร้างโทเค็นเพื่อการเข้าถึง OAuth 2.0

API_VERSION="20"
DEVELOPER_TOKEN="DEVELOPER_TOKEN"
OAUTH2_ACCESS_TOKEN="OAUTH_ACCESS_TOKEN"
MANAGER_CUSTOMER_ID="MANAGER_CUSTOMER_ID"
CUSTOMER_ID="CUSTOMER_ID"

รหัสออบเจ็กต์เพิ่มเติมที่ไม่บังคับ

ตัวอย่างต่อไปนี้บางส่วนใช้ได้กับงบประมาณหรือแคมเปญที่มีอยู่แล้ว หากคุณมีรหัสของออบเจ็กต์ที่มีอยู่ซึ่งจะใช้กับตัวอย่างเหล่านี้ ให้ป้อนรหัสตามที่แสดง

BUDGET_ID=BUDGET_ID
CAMPAIGN_ID=CAMPAIGN_ID

ไม่เช่นนั้น Mutates - Creates examples จะสร้างงบประมาณและแคมเปญใหม่

คำแนะนำสมุดตำราการค้นหามีตัวอย่างการรายงานมากมาย ที่สอดคล้องกับหน้าจอ Google Ads เริ่มต้นบางหน้าจอและทํางานร่วมกับ ตัวแปรสภาพแวดล้อมเดียวกันที่ใช้ในคําแนะนํานี้ เครื่องมือสร้างการค้นหาแบบอินเทอร์แอกทีฟยังเป็นแหล่งข้อมูลที่ยอดเยี่ยมสำหรับการสร้างการค้นหาที่กำหนดเองแบบอินเทอร์แอกทีฟอีกด้วย

แบ่งหน้า

search วิธีการใช้การแบ่งหน้า โดยมีขนาดหน้าคงที่ 10,000 รายการและ page_token ที่ระบุไว้ข้าง query

curl

curl -f --request POST "https://googleads.googleapis.com/v${API_VERSION}/customers/${CUSTOMER_ID}/googleAds:search" \
--header "Content-Type: application/json" \
--header "developer-token: ${DEVELOPER_TOKEN}" \
--header "login-customer-id: ${MANAGER_CUSTOMER_ID}" \
--header "Authorization: Bearer ${OAUTH2_ACCESS_TOKEN}" \
--data '{
"query": "
  SELECT campaign.name,
    campaign_budget.amount_micros,
    campaign.status,
    campaign.optimization_score,
    campaign.advertising_channel_type,
    metrics.clicks,
    metrics.impressions,
    metrics.ctr,
    metrics.average_cpc,
    metrics.cost_micros,
    campaign.bidding_strategy_type
  FROM campaign
  WHERE segments.date DURING LAST_7_DAYS
    AND campaign.status != 'REMOVED'
",
"page_token":"${PAGE_TOKEN}"
}'

GAQL

SELECT campaign.name,
  campaign_budget.amount_micros,
  campaign.status,
  campaign.optimization_score,
  campaign.advertising_channel_type,
  metrics.clicks,
  metrics.impressions,
  metrics.ctr,
  metrics.average_cpc,
  metrics.cost_micros,
  campaign.bidding_strategy_type
FROM campaign
WHERE segments.date DURING LAST_7_DAYS
  AND campaign.status != 'REMOVED'
### การสตรีม เมธอด `searchStream` จะสตรีมผลลัพธ์ทั้งหมดในการตอบกลับครั้งเดียว ดังนั้นจึงไม่รองรับฟิลด์ `pageSize`

curl

curl -f --request POST "https://googleads.googleapis.com/v${API_VERSION}/customers/${CUSTOMER_ID}/googleAds:searchStream" \
--header "Content-Type: application/json" \
--header "developer-token: ${DEVELOPER_TOKEN}" \
--header "login-customer-id: ${MANAGER_CUSTOMER_ID}" \
--header "Authorization: Bearer ${OAUTH2_ACCESS_TOKEN}" \
--data '{
"query": "
  SELECT campaign.name,
    campaign_budget.amount_micros,
    campaign.status,
    campaign.optimization_score,
    campaign.advertising_channel_type,
    metrics.clicks,
    metrics.impressions,
    metrics.ctr,
    metrics.average_cpc,
    metrics.cost_micros,
    campaign.bidding_strategy_type
  FROM campaign
  WHERE segments.date DURING LAST_7_DAYS
    AND campaign.status != 'REMOVED'
"
}'

GAQL

SELECT campaign.name,
  campaign_budget.amount_micros,
  campaign.status,
  campaign.optimization_score,
  campaign.advertising_channel_type,
  metrics.clicks,
  metrics.impressions,
  metrics.ctr,
  metrics.average_cpc,
  metrics.cost_micros,
  campaign.bidding_strategy_type
FROM campaign
WHERE segments.date DURING LAST_7_DAYS
  AND campaign.status != 'REMOVED'

เปลี่ยนแปลง

คุณส่งการดำเนินการเปลี่ยนแปลงหลายรายการ (create, update หรือ remove) ในเนื้อหาคำขอ JSON รายการเดียวได้โดยการป้อนข้อมูลอาร์เรย์ operations

สร้าง

ตัวอย่างนี้สร้างงบประมาณแคมเปญที่ใช้ร่วมกัน 2 รายการในคำขอเดียว

curl -f --request POST "https://googleads.googleapis.com/v${API_VERSION}/customers/${CUSTOMER_ID}/campaignBudgets:mutate" \
--header "Content-Type: application/json" \
--header "developer-token: ${DEVELOPER_TOKEN}" \
--header "login-customer-id: ${MANAGER_CUSTOMER_ID}" \
--header "Authorization: Bearer ${OAUTH2_ACCESS_TOKEN}" \
--data "{
'operations': [
  {
    'create': {
      'name': 'My Campaign Budget #${RANDOM}',
      'amountMicros': 500000,
    }
  },
  {
    'create': {
      'name': 'My Campaign Budget #${RANDOM}',
      'amountMicros': 500000,
    }
  }
]
}"

ตัวอย่างถัดไปใช้BUDGET_IDของงบประมาณแคมเปญที่มีอยู่ คุณสามารถคัดลอกและวางจากเอาต์พุตของขั้นตอนก่อนหน้าได้

BUDGET_ID=BUDGET_ID

ทรัพยากรที่อ้างอิงถึงทรัพยากรอื่นๆ จะอ้างอิงโดยใช้ชื่อทรัพยากร แคมเปญที่สร้างใน ตัวอย่างต่อไปนี้อ้างอิงถึง campaignBudget ตามชื่อทรัพยากรที่มีค่าเป็นสตริง 

curl -f --request POST "https://googleads.googleapis.com/v${API_VERSION}/customers/${CUSTOMER_ID}/campaigns:mutate" \
--header "Content-Type: application/json" \
--header "developer-token: ${DEVELOPER_TOKEN}" \
--header "login-customer-id: ${MANAGER_CUSTOMER_ID}" \
--header "Authorization: Bearer ${OAUTH2_ACCESS_TOKEN}" \
--data "{
'operations': [
  {
    'create': {
      'status': 'PAUSED',
      'advertisingChannelType': 'SEARCH',
      'geoTargetTypeSetting': {
        'positiveGeoTargetType': 'PRESENCE_OR_INTEREST',
        'negativeGeoTargetType': 'PRESENCE_OR_INTEREST'
      },
      'name': 'My Search campaign #${RANDOM}',
      'campaignBudget': 'customers/${CUSTOMER_ID}/campaignBudgets/${BUDGET_ID}',
      'targetSpend': {}
    }
  }
]
}"

อัปเดต

อัปเดตแอตทริบิวต์ของออบเจ็กต์ที่มีอยู่โดยใช้การดำเนินการ update ตัวอย่างถัดไป ใช้แคมเปญที่มีอยู่ คุณสามารถคัดลอกและวางจากเอาต์พุตของขั้นตอนก่อนหน้า ได้

CAMPAIGN_ID=CAMPAIGN_ID

การอัปเดตทั้งหมดต้องมีฟิลด์ updateMask ซึ่งเป็นรายการที่คั่นด้วยคอมมาของ แอตทริบิวต์ JSON ที่ควรอยู่ในคำขอ ซึ่งควรใช้เป็นการ อัปเดต ระบบจะล้างแอตทริบิวต์ที่ระบุไว้ใน updateMask แต่ไม่มีอยู่ในคำขอ เนื้อหาในออบเจ็กต์ ระบบจะไม่สนใจแอตทริบิวต์ที่ไม่ได้แสดงใน updateMask แต่มีอยู่ในเนื้อหาคำขอ

curl -f --request POST "https://googleads.googleapis.com/v${API_VERSION}/customers/${CUSTOMER_ID}/campaigns:mutate" \
--header "Content-Type: application/json" \
--header "developer-token: ${DEVELOPER_TOKEN}" \
--header "login-customer-id: ${MANAGER_CUSTOMER_ID}" \
--header "Authorization: Bearer ${OAUTH2_ACCESS_TOKEN}" \
--data "{
'operations': [
  {
    'update': {
      'resourceName': 'customers/${CUSTOMER_ID}/campaigns/${CAMPAIGN_ID}',
      'name': 'A changed campaign name #${RANDOM}',
    },
    'updateMask': 'name'
  }
],
}"

นำออก

ระบบจะนำออบเจ็กต์ออกโดยการระบุชื่อทรัพยากรเป็นremove

curl -f --request POST "https://googleads.googleapis.com/v${API_VERSION}/customers/${CUSTOMER_ID}/campaigns:mutate" \
--header "Content-Type: application/json" \
--header "developer-token: ${DEVELOPER_TOKEN}" \
--header "login-customer-id: ${MANAGER_CUSTOMER_ID}" \
--header "Authorization: Bearer ${OAUTH2_ACCESS_TOKEN}" \
--data "{
'operations': [
  {
    'remove': 'customers/${CUSTOMER_ID}/campaigns/${CAMPAIGN_ID}'
  }
],
}"

ไม่สำเร็จบางส่วน

เมื่อมีการดำเนินการหลายรายการในคำขอเดียว ให้ระบุ partialFailure โดยไม่บังคับ หาก true ระบบจะดำเนินการที่สำเร็จและ การดำเนินการที่ไม่ถูกต้องจะแสดงข้อผิดพลาด หาก false การดำเนินการทั้งหมดในคำขอจะ สำเร็จก็ต่อเมื่อการดำเนินการทั้งหมดถูกต้องเท่านั้น

ตัวอย่างถัดไปใช้แคมเปญที่มีอยู่ คุณสามารถคัดลอกและวางจากเอาต์พุตตัวอย่าง Creates ได้

CAMPAIGN_ID=CAMPAIGN_ID

คำขอต่อไปนี้มีการดำเนินการ 2 รายการ การพยายามครั้งแรกคือการเปลี่ยน กลยุทธ์การเสนอราคาของแคมเปญที่ระบุ และครั้งถัดไปคือการพยายามนำ แคมเปญที่มีรหัสไม่ถูกต้องออก เนื่องจากการดำเนินการที่ 2 ทำให้เกิดข้อผิดพลาด (รหัสแคมเปญไม่ถูกต้อง) และเนื่องจากตั้งค่า partialFailure เป็น false การดำเนินการแรกจึงไม่สำเร็จด้วย และระบบจะไม่ อัปเดตกลยุทธ์การเสนอราคาของแคมเปญที่มีอยู่

curl --request POST "https://googleads.googleapis.com/v${API_VERSION}/customers/${CUSTOMER_ID}/campaigns:mutate" \
--header "Content-Type: application/json" \
--header "developer-token: ${DEVELOPER_TOKEN}" \
--header "login-customer-id: ${MANAGER_CUSTOMER_ID}" \
--header "Authorization: Bearer ${OAUTH2_ACCESS_TOKEN}" \
--data "{
'partialFailure': false,
'operations': [
  {
    'update': {
      'resourceName': 'customers/${CUSTOMER_ID}/campaigns/${CAMPAIGN_ID}',
      'manualCpc': {
        'enhancedCpcEnabled': false
      }
    },
    'updateMask': 'manual_cpc.enhanced_cpc_enabled'
  },
  {
    'remove': 'customers/${CUSTOMER_ID}/campaigns/INVALID_CAMPAIGN_ID'
  }
]
}"

การดำเนินการแบบกลุ่ม

เมธอด googleAds:mutate รองรับการส่งกลุ่มการดำเนินการที่มี ทรัพยากรหลายประเภท คุณสามารถส่งการดำเนินการหลายรายการประเภทต่างๆ เพื่อ เชื่อมโยงลำดับของการดำเนินการที่ควรดำเนินการเป็นกลุ่ม ชุดการดำเนินการจะสำเร็จหากไม่มีการดำเนินการใดล้มเหลว หรือล้มเหลวทั้งหมดหากมีการดำเนินการใด การดำเนินการหนึ่งล้มเหลว

ตัวอย่างนี้แสดงการสร้างงบประมาณแคมเปญ แคมเปญ กลุ่มโฆษณา และ โฆษณาร่วมกันเป็นชุดการกระทําเดียว การดำเนินการแต่ละครั้งจะขึ้นอยู่กับการดำเนินการก่อนหน้า หากรายการใดรายการหนึ่งล้มเหลว การดำเนินการทั้งกลุ่มจะล้มเหลว

ระบบจะใช้จำนวนเต็มลบ (-1, -2, -3) เป็นตัวยึดตำแหน่งในชื่อทรัพยากร และจะกรอกข้อมูลแบบไดนามิกในรันไทม์ด้วยผลลัพธ์จากลำดับ ของการดำเนินการ

curl -f --request POST "https://googleads.googleapis.com/v${API_VERSION}/customers/${CUSTOMER_ID}/googleAds:mutate" \
--header "Content-Type: application/json" \
--header "developer-token: ${DEVELOPER_TOKEN}" \
--header "login-customer-id: ${MANAGER_CUSTOMER_ID}" \
--header "Authorization: Bearer ${OAUTH2_ACCESS_TOKEN}" \
--data "{
'mutateOperations': [
  {
    'campaignBudgetOperation': {
      'create': {
        'resourceName': 'customers/${CUSTOMER_ID}/campaignBudgets/-1',
        'name': 'My Campaign Budget #${RANDOM}',
        'deliveryMethod': 'STANDARD',
        'amountMicros': 500000,
        'explicitlyShared': false
      }
    }
  },
  {
    'campaignOperation': {
      'create': {
        'resourceName': 'customers/${CUSTOMER_ID}/campaigns/-2',
        'status': 'PAUSED',
        'advertisingChannelType': 'SEARCH',
        'geoTargetTypeSetting': {
          'positiveGeoTargetType': 'PRESENCE_OR_INTEREST',
          'negativeGeoTargetType': 'PRESENCE_OR_INTEREST'
        },
        'name': 'My Search campaign #${RANDOM}',
        'campaignBudget': 'customers/${CUSTOMER_ID}/campaignBudgets/-1',
        'targetSpend': {}
      }
    }
  },
  {
    'adGroupOperation': {
      'create': {
        'resourceName': 'customers/${CUSTOMER_ID}/adGroups/-3',
        'campaign': 'customers/${CUSTOMER_ID}/campaigns/-2',
        'name': 'My ad group #${RANDOM}',
        'status': 'PAUSED',
        'type': 'SEARCH_STANDARD'
      }
    }
  },
  {
    'adGroupAdOperation': {
      'create': {
        'adGroup': 'customers/${CUSTOMER_ID}/adGroups/-3',
        'status': 'PAUSED',
        'ad': {
          'responsiveSearchAd': {
            'headlines': [
              {
                'pinned_field': 'HEADLINE_1',
                'text': 'An example headline'
              },
              {
                'text': 'Another example headline'
              },
              {
                'text': 'Yet another headline'
              }
            ],
            'descriptions': [
              {
                'text': 'An example description'
              },
              {
                'text': 'Another example description'
              }
            ],
            'path1': 'all-inclusive',
            'path2': 'deals'
          },
          'finalUrls': ['https://www.example.com']
        }
      }
    }
  }
]
}"

การจัดการบัญชี

คุณสร้างบัญชี แสดงบัญชีที่เข้าถึงได้ และอัปโหลดเนื้อหาไบนารีได้

สร้างบัญชี

สร้างบัญชีใหม่โดยใช้วิธี createCustomerClient โปรดทราบว่า URL ต้องใช้รหัสบัญชีดูแลจัดการแทนรหัสบัญชีลูกค้า ระบบจะสร้างบัญชีลูกค้าใหม่ภายใต้บัญชีดูแลจัดการ

curl f --request POST "https://googleads.googleapis.com/v${API_VERSION}/customers/${MANAGER_CUSTOMER_ID}:createCustomerClient" \
--header "Content-Type: application/json" \
--header "developer-token: ${DEVELOPER_TOKEN}" \
--header "login-customer-id: ${MANAGER_CUSTOMER_ID}" \
--header "Authorization: Bearer ${OAUTH2_ACCESS_TOKEN}" \
--data "{
'customerClient': {
  'descriptiveName': 'My Client #${RANDOM}',
  'currencyCode': 'USD',
  'timeZone': 'America/New_York'
}
}"

แสดงรายการบัญชีที่เข้าถึงได้

ใช้GETคำขอlistAccessibleCustomersเมธอดอย่างง่ายเพื่อรับรายการบัญชี Google Ads ที่เข้าถึงได้ด้วยโทเค็นเพื่อการเข้าถึง OAuth 2.0 ที่ระบุ ไม่ควรใช้รหัสบัญชีดูแลจัดการ หรือบัญชีลูกค้าในคำขอนี้

curl -f --request GET "https://googleads.googleapis.com/v${API_VERSION}/customers:listAccessibleCustomers" \
--header "Content-Type: application/json" \
--header "developer-token: ${DEVELOPER_TOKEN}" \
--header "Authorization: Bearer ${OAUTH2_ACCESS_TOKEN}" \

อัปโหลดชิ้นงานไบนารี

ระบบจะใช้วิธี assets:mutate ในการอัปโหลดและจัดการชิ้นงาน ระบบจะเข้ารหัสข้อมูลไบนารี เช่น รูปภาพ เป็นสตริงโดยใช้การเข้ารหัส base64 มาตรฐานที่มีการเพิ่มช่องว่าง ระบบยอมรับการเข้ารหัส Base64 มาตรฐานหรือการเข้ารหัส Base64 ที่ปลอดภัยสำหรับ URL โดยมีหรือไม่มีการเพิ่ม Padding

ตัวอย่างนี้จะเข้ารหัส GIF ขนาด 1 พิกเซลเพื่อให้ตัวอย่างกระชับ ในทางปฏิบัติ เพย์โหลดของ data มีขนาดใหญ่กว่ามาก

ใช้ยูทิลิตีบรรทัดคำสั่ง base64 (ส่วนหนึ่งของยูทิลิตีหลักของ GNU) เพื่อเข้ารหัสรูปภาพ GIF ขนาด 1 พิกเซล

base64 1pixel.gif

ค่าที่เข้ารหัส Base64 จะระบุเป็นแอตทริบิวต์ data ในคำขอ API

curl -f --request POST "https://googleads.googleapis.com/v${API_VERSION}/customers/${CUSTOMER_ID}/assets:mutate" \
--header "Content-Type: application/json" \
--header "developer-token: ${DEVELOPER_TOKEN}" \
--header "login-customer-id: ${MANAGER_CUSTOMER_ID}" \
--header "Authorization: Bearer ${OAUTH2_ACCESS_TOKEN}" \
--data "{
'operations': [
  {
    'create': {
      'name': 'My image asset #${RANDOM}',
      'type': 'IMAGE',
      'imageAsset': {
        'data': 'R0lGODlhAQABAAAAACH5BAEAAAAALAAAAAABAAEAAAIA'
      }
    }
  }
]
}"
ก่อนหน้า
ข้อผิดพลาดที่พบบ่อย
ถัดไป
ลองใช้เลย