DismissNotifications Service Operation - Customer Management
通知を無視するサービス操作。
Request 要素
DismissNotificationsRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。 要素は、 要求 SOAP に示されている順序と同じ順序である必要があります。
注:
以下に特に記載がない限り、すべての要求要素が必要です。
要求本文要素
要素 | 説明 | データ型 |
---|---|---|
NotificationTypePairs | 通知エンティティのキーと値。 | KeyValueEntityOflongint 配列 |
UserId | ユーザーの識別番号。 | int |
要求ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
AuthenticationToken | Microsoft Advertising アカウントへのアクセス許可を持つユーザーの資格情報を表す OAuth アクセス トークン。 詳細については、「 OAuth による認証」を参照してください。 |
string |
DeveloperToken | Bing Ads API へのアクセスに使用される開発者トークン。 詳細については、「 開発者トークンを取得する」を参照してください。 |
string |
Password | この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 | string |
UserName | この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 | string |
Response 要素
DismissNotificationsResponse オブジェクトは、サービス操作応答の本文要素とヘッダー要素を定義します。 要素は、 応答 SOAP に示されている順序と同じ順序で返されます。
応答本文の要素
操作の応答本文には要素がありません。
応答ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
TrackingId | API 呼び出しの詳細を含むログ エントリの識別子。 | string |
SOAP を要求する
このテンプレートは、SOAP 要求の本文要素とヘッダー要素の順序を示すツールによって生成されました。 このサービス操作で使用できるサポートされる型については、上記の 要求本文要素 のリファレンスを参照してください。
<s:Envelope xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header xmlns="https://bingads.microsoft.com/Customer/v13">
<Action mustUnderstand="1">DismissNotifications</Action>
<AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
<DeveloperToken i:nil="false">ValueHere</DeveloperToken>
</s:Header>
<s:Body>
<DismissNotificationsRequest xmlns="https://bingads.microsoft.com/Customer/v13">
<UserId i:nil="false">ValueHere</UserId>
<NotificationTypePairs xmlns:e17="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
<e17:KeyValueEntityOflongint>
<e17:Key>ValueHere</e17:Key>
<e17:Value>ValueHere</e17:Value>
</e17:KeyValueEntityOflongint>
</NotificationTypePairs>
</DismissNotificationsRequest>
</s:Body>
</s:Envelope>
応答 SOAP
このテンプレートは、SOAP 応答の 本文 要素と ヘッダー 要素の順序を示すツールによって生成されました。
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header xmlns="https://bingads.microsoft.com/Customer/v13">
<TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
</s:Header>
<s:Body>
<DismissNotificationsResponse xmlns="https://bingads.microsoft.com/Customer/v13" />
</s:Body>
</s:Envelope>
コード構文
構文の例は、 Bing広告 SDK で使用できます。 その他 の例については、「Bing広告 API コードの例 」を参照してください。
public async Task<DismissNotificationsResponse> DismissNotificationsAsync(
int? userId,
IList<KeyValueEntityOflongint> notificationTypePairs)
{
var request = new DismissNotificationsRequest
{
UserId = userId,
NotificationTypePairs = notificationTypePairs
};
return (await CustomerManagementService.CallAsync((s, r) => s.DismissNotificationsAsync(r), request));
}
static DismissNotificationsResponse dismissNotifications(
int userId,
ArrayOfKeyValueEntityOflongint notificationTypePairs) throws RemoteException, Exception
{
DismissNotificationsRequest request = new DismissNotificationsRequest();
request.setUserId(userId);
request.setNotificationTypePairs(notificationTypePairs);
return CustomerManagementService.getService().dismissNotifications(request);
}
static function DismissNotifications(
$userId,
$notificationTypePairs)
{
$GLOBALS['Proxy'] = $GLOBALS['CustomerManagementProxy'];
$request = new DismissNotificationsRequest();
$request->UserId = $userId;
$request->NotificationTypePairs = $notificationTypePairs;
return $GLOBALS['CustomerManagementProxy']->GetService()->DismissNotifications($request);
}
response=customermanagement_service.DismissNotifications(
UserId=UserId,
NotificationTypePairs=NotificationTypePairs)
要件
サービス: CustomerManagementService.svc v13
Namespace: https://bingads.microsoft.com/Customer/v13
要求 URL
https://clientcenter.api.bingads.microsoft.com/CustomerManagement/v13/Notifications/Dismiss
Request 要素
DismissNotificationsRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。
注:
以下に特に記載がない限り、すべての要求要素が必要です。
要求本文要素
要素 | 説明 | データ型 |
---|---|---|
NotificationTypePairs | 通知エンティティのキーと値。 | KeyValueEntityOflongint 配列 |
UserId | ユーザーの識別番号。 | int |
要求ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
Authorization | Microsoft Advertising アカウントへのアクセス許可を持つユーザーの資格情報を表す OAuth アクセス トークン。 トークンのプレフィックスに "Bearer" があることを確認してください。これは、適切な認証に必要です。 詳細については、「 OAuth による認証」を参照してください。 |
string |
DeveloperToken | Bing Ads API へのアクセスに使用される開発者トークン。 詳細については、「 開発者トークンを取得する」を参照してください。 |
string |
Password | この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 | string |
UserName | この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 | string |
Response 要素
DismissNotificationsResponse オブジェクトは、サービス操作応答の本文要素とヘッダー要素を定義します。 要素は、 Response JSON に示されている順序と同じ順序で返されます。
応答本文の要素
操作の応答本文には要素がありません。
応答ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
TrackingId | API 呼び出しの詳細を含むログ エントリの識別子。 | string |
JSON を要求する
このテンプレートは、JSON 要求の 本文 と ヘッダー 要素を表示するツールによって生成されました。 このサービス操作で使用できるサポートされる型については、上記の 要求本文要素 のリファレンスを参照してください。
{
"UserId": IntValueHere,
"NotificationTypePairs": [
{
"Key": "LongValueHere",
"Value": IntValueHere
}
]
}
応答 JSON
このテンプレートは、JSON 応答の 本文 と ヘッダー 要素を表示するツールによって生成されました。
{}
コード構文
SDK を使用して REST API を呼び出すには、SDK を特定のバージョンにアップグレードし、システム パラメーターを構成する必要があります。構文の例は、 Bing広告 SDK で使用できます。 その他 の例については、「Bing広告 API コードの例 」を参照してください。
public async Task<DismissNotificationsResponse> DismissNotificationsAsync(
int? userId,
IList<KeyValueEntityOflongint> notificationTypePairs)
{
var request = new DismissNotificationsRequest
{
UserId = userId,
NotificationTypePairs = notificationTypePairs
};
return (await CustomerManagementService.CallAsync((s, r) => s.DismissNotificationsAsync(r), request));
}
static DismissNotificationsResponse dismissNotifications(
int userId,
ArrayOfKeyValueEntityOflongint notificationTypePairs) throws RemoteException, Exception
{
DismissNotificationsRequest request = new DismissNotificationsRequest();
request.setUserId(userId);
request.setNotificationTypePairs(notificationTypePairs);
return CustomerManagementService.getService().dismissNotifications(request);
}
static function DismissNotifications(
$userId,
$notificationTypePairs)
{
$GLOBALS['Proxy'] = $GLOBALS['CustomerManagementProxy'];
$request = new DismissNotificationsRequest();
$request->UserId = $userId;
$request->NotificationTypePairs = $notificationTypePairs;
return $GLOBALS['CustomerManagementProxy']->GetService()->DismissNotifications($request);
}
response=customermanagement_service.DismissNotifications(
UserId=UserId,
NotificationTypePairs=NotificationTypePairs)