最初の API 呼び出しを行う

[アーティクル]
11/13/2024

重要

2022 年 6 月には、Bing Adsの要件として多要素認証を導入しました。この要件に準拠するには、引き続きコードの変更が必要な場合があります。 Microsoft Advertising は、10 月初旬に技術的な適用チェックを実行しています。

このブログ投稿では、コンプライアンスを確保するために実行する必要がある手順について説明します。

詳細については、多要素認証要件ガイドを参照してください。

すぐに作業したい場合は、次の手順に従って Microsoft Advertising ユーザー情報を取得します。

運用クイックスタート

運用環境で認証するには、まずアプリケーションを登録する必要があります。 Microsoft アカウントの資格情報でサインインし、Microsoft Advertising アカウントの管理にアプリの同意を付与します。

新しいファイルを作成し、次のスクリプトを貼り付けます。登録済みアプリのアプリケーション ID に設定 $clientId します。 Web アプリケーションをクライアントシークレットに登録した場合は、アクセストークンを要求するときにも含める $client_secret=YourWebAppClientSecret 必要があります。

注:

以下のyour_client_idを、Azure portalポータルによってアプリが割り当てられたアプリケーション (クライアント) ID アプリの登録置き換えます。

# Replace your_client_id with your registered application ID. 
$clientId = "your_client_id"

Start-Process "https://login.microsoftonline.com/common/oauth2/v2.0/authorize?client_id=$clientId&scope=openid%20profile%20https://ads.microsoft.com/msads.manage%20offline_access&response_type=code&redirect_uri=https://login.microsoftonline.com/common/oauth2/nativeclient&state=ClientStateGoesHere&prompt=login"

$code = Read-Host "Grant consent in the browser, and then enter the response URI here:"
$code = $code -match 'code=(.*)\&'
$code = $Matches[1]

# Get the initial access and refresh tokens. 

$response = Invoke-WebRequest https://login.microsoftonline.com/common/oauth2/v2.0/token -ContentType application/x-www-form-urlencoded -Method POST -Body "client_id=$clientId&scope=https://ads.microsoft.com/msads.manage%20offline_access&code=$code&grant_type=authorization_code&redirect_uri=https%3A%2F%2Flogin.microsoftonline.com%2Fcommon%2Foauth2%2Fnativeclient"

$oauthTokens = ($response.Content | ConvertFrom-Json)  
Write-Output "Access token: " $oauthTokens.access_token  
Write-Output "Access token expires in: " $oauthTokens.expires_in  
Write-Output "Refresh token: " $oauthTokens.refresh_token 

# The access token will expire e.g., after one hour. 
# Use the refresh token to get new access and refresh tokens. 

$response = Invoke-WebRequest https://login.microsoftonline.com/common/oauth2/v2.0/token -ContentType application/x-www-form-urlencoded -Method POST -Body "client_id=$clientId&scope=https://ads.microsoft.com/msads.manage%20offline_access&code=$code&grant_type=refresh_token&refresh_token=$($oauthTokens.refresh_token)"

$oauthTokens = ($response.Content | ConvertFrom-Json)  
Write-Output "Access token: " $oauthTokens.access_token  
Write-Output "Access token expires in: " $oauthTokens.expires_in  
Write-Output "Refresh token: " $oauthTokens.refresh_token

ファイルを保存して名前を付 Get-Tokens-Production.ps1 けます (名前は任意ですが、拡張子は .ps1 する必要があります)。

Microsoft Advertising アカウントをプログラムで管理するには、Web アプリケーションの同意フローを通じて少なくとも 1 回は同意を提供する必要があります。それ以降は、最新の更新トークンを使用して、ユーザーの操作を行わずに新しいアクセストークンと更新トークンを要求できます。

次に、 Get-Tokens-Production.ps1 コンソールウィンドウを開きます。コマンドプロンプトで、保存 Get-Tokens-Production.ps1 したフォルダーに移動し、次のコマンドを入力します。
```
powershell.exe -File .\Get-Tokens-Production.ps1
```
PowerShell スクリプトが正常に実行されると、Microsoft Advertising 資格情報を入力するブラウザーセッションが開始されます。同意すると、ブラウザーのアドレスバーに許可コードが含まれます (「?code=UseThisCode&...」を参照してください)。
```
https://login.microsoftonline.com/common/oauth2/nativeclient?code=M.R4_BAY.f202904c-2269-4daf-1e21-862ed4d49143
```
許可コード (独自のコードではなく、例 M.R4_BAY.f202904c-2269-4daf-1e21-862ed4d49143) をコピーし、プロンプトのコンソールウィンドウに入力します。 PowerShell スクリプトは、アクセストークンと更新トークンを返します。 (スクリプトは、トークンを更新する方法の例として、Invoke-WebRequest に対して 2 回目の呼び出しを行います)。更新トークンは、パスワードと同様に扱う必要があります。誰かがそれを手に入れると、リソースにアクセスできます。更新トークンは有効期間が長いですが、無効になる可能性があります。 invalid_grant エラーが発生した場合、更新トークンは無効になり、ユーザーの同意と新しい更新トークンを Get-Tokens-Production.ps1 取得するには、PowerShell スクリプトをもう一度実行する必要があります。

新しいファイルを作成し、次のスクリプトを貼り付けます。をaccessTokenからGet-Tokens-Production.ps1受け取った値に設定し、ここで説明する次の手順で受け取った開発者トークンに設定$developerTokenします。

$accessToken = "AccessTokenGoesHere";
$developerToken = "DeveloperTokenGoesHere";

[xml]$getUserRequest = 
'<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v13="https://bingads.microsoft.com/Customer/v13">
<soapenv:Header>
   <v13:DeveloperToken>{0}</v13:DeveloperToken>
   <v13:AuthenticationToken>{1}</v13:AuthenticationToken>
</soapenv:Header>
<soapenv:Body>
   <v13:GetUserRequest>
      <v13:UserId xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
   </v13:GetUserRequest>
</soapenv:Body>
</soapenv:Envelope>' -f $developerToken, $accessToken

$headers = @{"SOAPAction" = "GetUser"}

$uri = "https://clientcenter.api.bingads.microsoft.com/Api/CustomerManagement/v13/CustomerManagementService.svc"
$response = Invoke-WebRequest $uri -Method post -ContentType 'text/xml' -Body $getUserRequest -Headers $headers
Write-Output $response.Content

ファイルを保存して名前を付 Get-User.ps1 けます (名前は任意ですが、拡張子は .ps1 する必要があります)。

次に、 Get-User.ps1 コンソールウィンドウを開きます。コマンドプロンプトで、保存 Get-User.ps1 したフォルダーに移動し、次のコマンドを入力します。
```
powershell.exe -File .\Get-User.ps1
```
PowerShell スクリプトが正常に実行されると、顧客ロールを含む Microsoft Advertising ユーザーの詳細が出力されます。詳細については、「 GetUser」を参照してください。

サンドボックスクイックスタート

サンドボックス環境で認証するには、アプリケーションを登録する必要はありません。パブリックの "チュートリアルサンプルアプリ" クライアント ID ( 00001111-aaaa-2222-bbbb-3333cccc4444) を使用するだけです。

Microsoft Advertising サンドボックスアカウントにサインアップします。 Microsoft アカウント (MSA) のメールアドレスは outlook-int.com である必要があります (例: someone@outlook-int.com)。詳細については、「サンドボックス」を参照してください。

新しいファイルを作成し、次のスクリプトを貼り付けます。

# Replace the Tutorial Sample App ID with your registered application ID. 
$clientId = "00001111-aaaa-2222-bbbb-3333cccc4444"

Start-Process "https://login.windows-ppe.net/consumers/oauth2/v2.0/authorize?client_id=$clientId&scope=openid%20profile%20https://api.ads.microsoft.com/msads.manage%20offline_access&response_type=code&redirect_uri=https://login.windows-ppe.net/common/oauth2/nativeclient&state=ClientStateGoesHere&prompt=login"

$code = Read-Host "Grant consent in the browser, and then enter the response URI here:"
$code = $code -match 'code=(.*)\&'
$code = $Matches[1]

# Get the initial access and refresh tokens. 

$response = Invoke-WebRequest https://login.windows-ppe.net/consumers/oauth2/v2.0/token -ContentType application/x-www-form-urlencoded -Method POST -Body "client_id=$clientId&scope=https://api.ads.microsoft.com/msads.manage%20offline_access&code=$code&grant_type=authorization_code&redirect_uri=https://login.windows-ppe.net/common/oauth2/nativeclient"

$oauthTokens = ($response.Content | ConvertFrom-Json)  
Write-Output "Access token: " $oauthTokens.access_token  
Write-Output "Access token expires in: " $oauthTokens.expires_in  
Write-Output "Refresh token: " $oauthTokens.refresh_token 

# The access token will expire e.g., after one hour. 
# Use the refresh token to get new access and refresh tokens. 

$response = Invoke-WebRequest https://login.windows-ppe.net/consumers/oauth2/v2.0/token -ContentType application/x-www-form-urlencoded -Method POST -Body "client_id=$clientId&scope=https://api.ads.microsoft.com/msads.manage%20offline_access&code=$code&grant_type=refresh_token&refresh_token=$($oauthTokens.refresh_token)"

$oauthTokens = ($response.Content | ConvertFrom-Json)  
Write-Output "Access token: " $oauthTokens.access_token  
Write-Output "Access token expires in: " $oauthTokens.expires_in  
Write-Output "Refresh token: " $oauthTokens.refresh_token

ファイルを保存して名前を付 Get-Tokens-Sandbox.ps1 けます (名前は任意ですが、拡張子は .ps1 する必要があります)。

ユーザーは、Web アプリケーションの同意フローを通じて少なくとも 1 回は同意を提供する必要があります。それ以降は、最新の更新トークンを使用して、ユーザーの操作を行わずに新しいアクセストークンと更新トークンを要求できます。

次に、 Get-Tokens-Sandbox.ps1 コンソールウィンドウを開きます。コマンドプロンプトで、保存 Get-Tokens-Sandbox.ps1 したフォルダーに移動し、次のコマンドを入力します。
```
powershell.exe -File .\Get-Tokens-Sandbox.ps1
```
PowerShell スクリプトが正常に実行されると、Microsoft Advertising 資格情報を入力するブラウザーセッションが開始されます。同意すると、ブラウザーのアドレスバーに許可コードが含まれます (「?code=UseThisCode&...」を参照してください)。
```
https://login.windows-ppe.net/common/oauth2/nativeclient?code=M.R0_CD1.132de532-5105-7550-b1fd-d37f9af2f009
```
許可コード (独自のコードではなく、例 M.R0_CD1.132de532-5105-7550-b1fd-d37f9af2f009) をコピーし、プロンプトのコンソールウィンドウに入力します。 PowerShell スクリプトは、アクセストークンと更新トークンを返します。 (スクリプトは、トークンを更新する方法の例として、Invoke-WebRequest に対して 2 回目の呼び出しを行います)。更新トークンは、パスワードと同様に扱う必要があります。誰かがそれを手に入れると、リソースにアクセスできます。更新トークンは有効期間が長いですが、無効になる可能性があります。 invalid_grant エラーが発生した場合、更新トークンは無効になり、ユーザーの同意と新しい更新トークンを Get-Tokens-Sandbox.ps1 取得するには、PowerShell スクリプトをもう一度実行する必要があります。

新しいファイルを作成し、次のスクリプトを貼り付けます。からaccessTokenGet-Tokens-Sandbox.ps1受け取った値にを設定します。

$accessToken = "AccessTokenGoesHere";
$developerToken = "BBD37VB98";

[xml]$getUserRequest = 
'<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v13="https://bingads.microsoft.com/Customer/v13">
<soapenv:Header>
   <v13:DeveloperToken>{0}</v13:DeveloperToken>
   <v13:AuthenticationToken>{1}</v13:AuthenticationToken>
</soapenv:Header>
<soapenv:Body>
   <v13:GetUserRequest>
      <v13:UserId xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
   </v13:GetUserRequest>
</soapenv:Body>
</soapenv:Envelope>' -f $developerToken, $accessToken

$headers = @{"SOAPAction" = "GetUser"}

$uri = "https://clientcenter.api.sandbox.bingads.microsoft.com/Api/CustomerManagement/v13/CustomerManagementService.svc"
$response = Invoke-WebRequest $uri -Method post -ContentType 'text/xml' -Body $getUserRequest -Headers $headers
Write-Output $response.Content

ファイルを保存して名前を付 Get-User.ps1 けます (名前は任意ですが、拡張子は .ps1 する必要があります)。

次に、 Get-User.ps1 コンソールウィンドウを開きます。コマンドプロンプトで、保存 Get-User.ps1 したフォルダーに移動し、次のコマンドを入力します。
```
powershell.exe -File .\Get-User.ps1
```
PowerShell スクリプトが正常に実行されると、顧客ロールを含む Microsoft Advertising ユーザーの詳細が出力されます。詳細については、「 GetUser」を参照してください。

次の方法で共有

最初の API 呼び出しを行う

運用クイックスタート

サンドボックスクイックスタート

関連項目

フィードバック

その他のリソース

次の方法で共有

最初の API 呼び出しを行う

運用クイック スタート

サンドボックス クイック スタート

関連項目

フィードバック

その他のリソース

運用クイックスタート

サンドボックスクイックスタート