GetAudienceFullEstimation サービス操作 - Ad Insight
対象ユーザーの完全な見積もりを取得します。
Request 要素
GetAudienceFullEstimationRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。 要素は、 要求 SOAP に示されている順序と同じ順序である必要があります。
注:
以下に特に記載がない限り、すべての要求要素が必要です。
要求本文要素
要素 | 説明 | データ型 |
---|---|---|
年齢 | 年齢ターゲティングの選択。 使用できる値は、 18ToTwentyFour、 TwentyFiveToThirtyFour、 ThreeFiveToFourtyNine、 FiftyToSixtyFour、 SixtyFiveAndAbove、 Unknown です。 足す: 随意。 既定値は null です。 更新: 随意 |
SelectionOfAgeEnum |
Audience | 対象ユーザーの選択。 サポートされている対象ユーザーの種類は、カスタム オーディエンス、複合リスト、カスタマー マッチ リスト、動的リマーケティング リスト、インマーケット オーディエンス、リマーケティング リスト、類似ユーザーです。 選択に格納されている値は、セグメント ID を参照します。 足す: 随意。 既定値は null です。 更新: 随意 |
SelectionOflong |
入札 | 目的の入札設定の値。 null に設定すると、推奨される入札が見積もりを実行するために使用されます。 足す: 随意 更新: 随意 |
小数 |
CampaignBiddingStrategy | 推定応答に必要な入札戦略を示します。 サポートされる値は 、5: EnhancedCPC、 12: ManualCP です。 足す: 随意。 既定値は [手動] です。 更新: 随意 |
int |
CampaignSubType | 推定応答に必要な広告の種類を示します。 サポートされる値は、*0: StaticAds、 1: FeedBasedAds、 2: DynamicFeedBasedAds です。 足す: 随意。 既定値は StaticAds です。 更新: 随意 |
int |
Company | LinkedIn プロファイルターゲットの会社。 選択に格納されている値は、セグメント ID を参照します。 足す: 随意。 既定値は null です。 更新: 随意 |
SelectionOflong |
通貨 |
DailyBudget と Bid の通貨。 null の場合、アカウント設定の通貨が使用されます。 足す: 随意。 既定値は null です。 更新: 随意 |
Currency |
DailyBudget | 1 日のキャンペーン予算値。 null に設定すると、見積もりを実行するために推奨される予算が使用されます。 足す: 随意。 既定値は null です。 更新: 随意 |
小数 |
フィード | CampaignSubType が FeedBasedAds または DynamicFeedBasedAds の場合にのみ、このパラメーターを使用してください。 推定としてカウントする目的のフィード トラフィックを指定します。 足す: 随意。 既定値は null です。 更新: 随意 |
フィード |
Gender | ターゲットにする性別。 使用可能な値は、 男性、 女性、 不明です。 足す: 随意。 既定値は null です。 更新: 随意 |
SelectionOfGenderEnum |
産業 | LinkedIn プロファイル ターゲットの業界。 選択に格納されている値は、セグメント ID を参照します。 足す: 随意。 既定値は null です。 更新: 随意 |
SelectionOflong |
JobFunction | ジョブ機能 LinkedIn プロファイルターゲットの業界。 選択に格納されている値は、セグメント ID を参照します。 足す: 随意。 既定値は null です。 更新: 随意 |
SelectionOflong |
場所 | ターゲットとなる場所の選択。 選択に格納されている値は、場所 ID を参照します。 足す: 随意。 既定値は null です。 更新: 随意 |
SelectionOflong |
RadiusTargets | マイル/キロメートルの観点から目的の地理的領域を表します。 足す: 随意。 既定値は null です。 更新: 随意 |
RadiusTarget 配列 |
要求ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
AuthenticationToken | Microsoft Advertising アカウントへのアクセス許可を持つユーザーの資格情報を表す OAuth アクセス トークン。 詳細については、「 OAuth による認証」を参照してください。 |
string |
CustomerAccountId | 要求のエンティティを所有または関連付けられている広告アカウントの識別子。 両方が必要な場合、このヘッダー要素の値は AccountId 本文要素と同じである必要があります。 この要素は、ほとんどのサービス操作に必要であり、ベスト プラクティスとして常に設定する必要があります。 詳細については、「 アカウントと顧客 ID を取得する」を参照してください。 |
string |
CustomerId | ユーザーがアクセスまたは操作しているマネージャー アカウント (顧客) の識別子。 ユーザーは複数のマネージャー アカウントにアクセスできます。 この要素は、ほとんどのサービス操作に必要であり、ベスト プラクティスとして常に設定する必要があります。 詳細については、「 アカウントと顧客 ID を取得する」を参照してください。 |
string |
DeveloperToken | Bing Ads API へのアクセスに使用される開発者トークン。 詳細については、「 開発者トークンを取得する」を参照してください。 |
string |
Password | この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 | string |
UserName | この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 | string |
Response 要素
GetAudienceFullEstimationResponse オブジェクトは、サービス操作応答の本文とヘッダー要素を定義します。 要素は、 応答 SOAP に示されている順序と同じ順序で返されます。
応答本文の要素
要素 | 説明 | データ型 |
---|---|---|
通貨 |
DailyBudget と Bid の通貨。 null の場合、アカウント設定の通貨が使用されます。 足す: 随意。 既定値は null です。 更新: 随意 |
Currency |
EstAudienceSize | 四捨五入された結果を含む月間推定リーチ ユーザー数。 出力のみ。 | RangeResultOfDecimalRoundedResult |
EstClick | 範囲の結果を含む月間推定ユーザー数。 出力のみ。 | RangeResultOfDecimalRoundedResult |
EstCostPerEvent | イベントあたりの推定コストを示します。 フィールドの意味は、 CampaignBiddingStrategy 要求フィールドによって異なります。 出力のみ。 EnhancedCPC: CPC ManualCPM: CPM |
RangeResultOfDecimalRoundedResult |
EstCTR | 範囲の結果を含む推定クリックスルー率 (CTR)。 出力のみ。 | RangeResultOfdouble |
EstImpression | 範囲の結果を含む月間推定インプレッション数。 出力のみ。 | RangeResultOfDecimalRoundedResult |
EstReachAudienceSize | 範囲の結果を含む月間推定ユーザー数。 出力のみ。 | DecimalRoundedResult |
EstReachImpression | 範囲の結果を含む月間推定インプレッション数。 出力のみ。 | DecimalRoundedResult |
EstSpend | 範囲の結果を含む月間推定支出。 出力のみ。 | RangeResultOfDecimalRoundedResult |
EventsLostToBid | 入力入札が不十分なため、イベントが失われた回数を示します。 イベントの損失の種類は、 CampaignBiddingStrategy 要求フィールドによって異なります。 出力のみ。 EnhancedCPC: をクリックします。 ManualCPM: インプレッション |
int |
EventsLostToBudget | 入力予算が不十分なため、イベントの損失数を示します。 イベントの損失の種類は、 CampaignBiddingStrategy 要求フィールドによって異なります。 出力のみ。 EnhancedCPC: をクリックします。 ManualCPM: インプレッション |
int |
SuggestedBid | 現在のターゲティングで推奨される入札価格。 出力のみ。 | 小数 |
SuggestedBudget | 現在のターゲット設定と入札で推奨される 1 日の予算値。 出力のみ。 | 小数 |
応答ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
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/AdInsight/v13">
<Action mustUnderstand="1">GetAudienceFullEstimation</Action>
<AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
<CustomerAccountId i:nil="false">ValueHere</CustomerAccountId>
<CustomerId i:nil="false">ValueHere</CustomerId>
<DeveloperToken i:nil="false">ValueHere</DeveloperToken>
</s:Header>
<s:Body>
<GetAudienceFullEstimationRequest xmlns="https://bingads.microsoft.com/AdInsight/v13">
<Age i:nil="false">
<Includes i:nil="false">
<AgeEnum>ValueHere</AgeEnum>
</Includes>
<Excludes i:nil="false">
<AgeEnum>ValueHere</AgeEnum>
</Excludes>
</Age>
<Gender i:nil="false">
<Includes i:nil="false">
<GenderEnum>ValueHere</GenderEnum>
</Includes>
<Excludes i:nil="false">
<GenderEnum>ValueHere</GenderEnum>
</Excludes>
</Gender>
<Audience i:nil="false">
<Includes i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</Includes>
<Excludes i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</Excludes>
</Audience>
<Company i:nil="false">
<Includes i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</Includes>
<Excludes i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</Excludes>
</Company>
<Industry i:nil="false">
<Includes i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</Includes>
<Excludes i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</Excludes>
</Industry>
<JobFunction i:nil="false">
<Includes i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</Includes>
<Excludes i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</Excludes>
</JobFunction>
<Location i:nil="false">
<Includes i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</Includes>
<Excludes i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</Excludes>
</Location>
<RadiusTargets i:nil="false">
<RadiusTarget>
<Radius>ValueHere</Radius>
<RadiusUnit>ValueHere</RadiusUnit>
<CenterLatitude>ValueHere</CenterLatitude>
<CenterLongitude>ValueHere</CenterLongitude>
</RadiusTarget>
</RadiusTargets>
<CampaignBiddingStrategy i:nil="false">ValueHere</CampaignBiddingStrategy>
<CampaignSubType i:nil="false">ValueHere</CampaignSubType>
<Feed i:nil="false">
<StoreId i:nil="false">ValueHere</StoreId>
<FeedId i:nil="false">ValueHere</FeedId>
<FeedType i:nil="false">ValueHere</FeedType>
</Feed>
<DailyBudget i:nil="false">ValueHere</DailyBudget>
<Bid i:nil="false">ValueHere</Bid>
<Currency i:nil="false">ValueHere</Currency>
</GetAudienceFullEstimationRequest>
</s:Body>
</s:Envelope>
応答 SOAP
このテンプレートは、SOAP 応答の 本文 要素と ヘッダー 要素の順序を示すツールによって生成されました。
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header xmlns="https://bingads.microsoft.com/AdInsight/v13">
<TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
</s:Header>
<s:Body>
<GetAudienceFullEstimationResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
<EstImpression d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<High d4p1:nil="false">
<Value d4p1:nil="false">ValueHere</Value>
<Unit d4p1:nil="false">ValueHere</Unit>
</High>
<Low d4p1:nil="false">
<Value d4p1:nil="false">ValueHere</Value>
<Unit d4p1:nil="false">ValueHere</Unit>
</Low>
</EstImpression>
<EstAudienceSize d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<High d4p1:nil="false">
<Value d4p1:nil="false">ValueHere</Value>
<Unit d4p1:nil="false">ValueHere</Unit>
</High>
<Low d4p1:nil="false">
<Value d4p1:nil="false">ValueHere</Value>
<Unit d4p1:nil="false">ValueHere</Unit>
</Low>
</EstAudienceSize>
<EstClick d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<High d4p1:nil="false">
<Value d4p1:nil="false">ValueHere</Value>
<Unit d4p1:nil="false">ValueHere</Unit>
</High>
<Low d4p1:nil="false">
<Value d4p1:nil="false">ValueHere</Value>
<Unit d4p1:nil="false">ValueHere</Unit>
</Low>
</EstClick>
<EstSpend d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<High d4p1:nil="false">
<Value d4p1:nil="false">ValueHere</Value>
<Unit d4p1:nil="false">ValueHere</Unit>
</High>
<Low d4p1:nil="false">
<Value d4p1:nil="false">ValueHere</Value>
<Unit d4p1:nil="false">ValueHere</Unit>
</Low>
</EstSpend>
<EstCostPerEvent d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<High d4p1:nil="false">
<Value d4p1:nil="false">ValueHere</Value>
<Unit d4p1:nil="false">ValueHere</Unit>
</High>
<Low d4p1:nil="false">
<Value d4p1:nil="false">ValueHere</Value>
<Unit d4p1:nil="false">ValueHere</Unit>
</Low>
</EstCostPerEvent>
<EstCTR d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<High>ValueHere</High>
<Low>ValueHere</Low>
</EstCTR>
<SuggestedBid d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</SuggestedBid>
<SuggestedBudget d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</SuggestedBudget>
<EventsLostToBid d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</EventsLostToBid>
<EventsLostToBudget d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</EventsLostToBudget>
<EstReachAudienceSize d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<Value d4p1:nil="false">ValueHere</Value>
<Unit d4p1:nil="false">ValueHere</Unit>
</EstReachAudienceSize>
<EstReachImpression d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<Value d4p1:nil="false">ValueHere</Value>
<Unit d4p1:nil="false">ValueHere</Unit>
</EstReachImpression>
<Currency d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</Currency>
</GetAudienceFullEstimationResponse>
</s:Body>
</s:Envelope>
コード構文
構文の例は、 Bing広告 SDK で使用できます。 その他 の例については、「Bing広告 API コードの例 」を参照してください。
public async Task<GetAudienceFullEstimationResponse> GetAudienceFullEstimationAsync(
SelectionOfAgeEnum age,
SelectionOfGenderEnum gender,
SelectionOflong audience,
SelectionOflong company,
SelectionOflong industry,
SelectionOflong jobFunction,
SelectionOflong location,
IList<RadiusTarget> radiusTargets,
int? campaignBiddingStrategy,
int? campaignSubType,
Feed feed,
decimal? dailyBudget,
decimal? bid,
Currency? currency)
{
var request = new GetAudienceFullEstimationRequest
{
Age = age,
Gender = gender,
Audience = audience,
Company = company,
Industry = industry,
JobFunction = jobFunction,
Location = location,
RadiusTargets = radiusTargets,
CampaignBiddingStrategy = campaignBiddingStrategy,
CampaignSubType = campaignSubType,
Feed = feed,
DailyBudget = dailyBudget,
Bid = bid,
Currency = currency
};
return (await AdInsightService.CallAsync((s, r) => s.GetAudienceFullEstimationAsync(r), request));
}
static GetAudienceFullEstimationResponse getAudienceFullEstimation(
SelectionOfAgeEnum age,
SelectionOfGenderEnum gender,
SelectionOflong audience,
SelectionOflong company,
SelectionOflong industry,
SelectionOflong jobFunction,
SelectionOflong location,
ArrayOfRadiusTarget radiusTargets,
int campaignBiddingStrategy,
int campaignSubType,
Feed feed,
decimal dailyBudget,
decimal bid,
Currency currency) throws RemoteException, Exception
{
GetAudienceFullEstimationRequest request = new GetAudienceFullEstimationRequest();
request.setAge(age);
request.setGender(gender);
request.setAudience(audience);
request.setCompany(company);
request.setIndustry(industry);
request.setJobFunction(jobFunction);
request.setLocation(location);
request.setRadiusTargets(radiusTargets);
request.setCampaignBiddingStrategy(campaignBiddingStrategy);
request.setCampaignSubType(campaignSubType);
request.setFeed(feed);
request.setDailyBudget(dailyBudget);
request.setBid(bid);
request.setCurrency(currency);
return AdInsightService.getService().getAudienceFullEstimation(request);
}
static function GetAudienceFullEstimation(
$age,
$gender,
$audience,
$company,
$industry,
$jobFunction,
$location,
$radiusTargets,
$campaignBiddingStrategy,
$campaignSubType,
$feed,
$dailyBudget,
$bid,
$currency)
{
$GLOBALS['Proxy'] = $GLOBALS['AdInsightProxy'];
$request = new GetAudienceFullEstimationRequest();
$request->Age = $age;
$request->Gender = $gender;
$request->Audience = $audience;
$request->Company = $company;
$request->Industry = $industry;
$request->JobFunction = $jobFunction;
$request->Location = $location;
$request->RadiusTargets = $radiusTargets;
$request->CampaignBiddingStrategy = $campaignBiddingStrategy;
$request->CampaignSubType = $campaignSubType;
$request->Feed = $feed;
$request->DailyBudget = $dailyBudget;
$request->Bid = $bid;
$request->Currency = $currency;
return $GLOBALS['AdInsightProxy']->GetService()->GetAudienceFullEstimation($request);
}
response=adinsight_service.GetAudienceFullEstimation(
Age=Age,
Gender=Gender,
Audience=Audience,
Company=Company,
Industry=Industry,
JobFunction=JobFunction,
Location=Location,
RadiusTargets=RadiusTargets,
CampaignBiddingStrategy=CampaignBiddingStrategy,
CampaignSubType=CampaignSubType,
Feed=Feed,
DailyBudget=DailyBudget,
Bid=Bid,
Currency=Currency)
要件
Service: AdInsightService.svc v13
Namespace: https://bingads.microsoft.com/AdInsight/v13
要求 URL
https://adinsight.api.bingads.microsoft.com/AdInsight/v13/AudienceFullEstimation/Query
Request 要素
GetAudienceFullEstimationRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。
注:
以下に特に記載がない限り、すべての要求要素が必要です。
要求本文要素
要素 | 説明 | データ型 |
---|---|---|
年齢 | 年齢ターゲティングの選択。 使用できる値は、 18ToTwentyFour、 TwentyFiveToThirtyFour、 ThreeFiveToFourtyNine、 FiftyToSixtyFour、 SixtyFiveAndAbove、 Unknown です。 足す: 随意。 既定値は null です。 更新: 随意 |
SelectionOfAgeEnum |
Audience | 対象ユーザーの選択。 サポートされている対象ユーザーの種類は、カスタム オーディエンス、複合リスト、カスタマー マッチ リスト、動的リマーケティング リスト、インマーケット オーディエンス、リマーケティング リスト、類似ユーザーです。 選択に格納されている値は、セグメント ID を参照します。 足す: 随意。 既定値は null です。 更新: 随意 |
SelectionOflong |
入札 | 目的の入札設定の値。 null に設定すると、推奨される入札が見積もりを実行するために使用されます。 足す: 随意 更新: 随意 |
小数 |
CampaignBiddingStrategy | 推定応答に必要な入札戦略を示します。 サポートされる値は 、5: EnhancedCPC、 12: ManualCP です。 足す: 随意。 既定値は [手動] です。 更新: 随意 |
int |
CampaignSubType | 推定応答に必要な広告の種類を示します。 サポートされる値は、*0: StaticAds、 1: FeedBasedAds、 2: DynamicFeedBasedAds です。 足す: 随意。 既定値は StaticAds です。 更新: 随意 |
int |
Company | LinkedIn プロファイルターゲットの会社。 選択に格納されている値は、セグメント ID を参照します。 足す: 随意。 既定値は null です。 更新: 随意 |
SelectionOflong |
通貨 |
DailyBudget と Bid の通貨。 null の場合、アカウント設定の通貨が使用されます。 足す: 随意。 既定値は null です。 更新: 随意 |
Currency |
DailyBudget | 1 日のキャンペーン予算値。 null に設定すると、見積もりを実行するために推奨される予算が使用されます。 足す: 随意。 既定値は null です。 更新: 随意 |
小数 |
フィード | CampaignSubType が FeedBasedAds または DynamicFeedBasedAds の場合にのみ、このパラメーターを使用してください。 推定としてカウントする目的のフィード トラフィックを指定します。 足す: 随意。 既定値は null です。 更新: 随意 |
フィード |
Gender | ターゲットにする性別。 使用可能な値は、 男性、 女性、 不明です。 足す: 随意。 既定値は null です。 更新: 随意 |
SelectionOfGenderEnum |
産業 | LinkedIn プロファイル ターゲットの業界。 選択に格納されている値は、セグメント ID を参照します。 足す: 随意。 既定値は null です。 更新: 随意 |
SelectionOflong |
JobFunction | ジョブ機能 LinkedIn プロファイルターゲットの業界。 選択に格納されている値は、セグメント ID を参照します。 足す: 随意。 既定値は null です。 更新: 随意 |
SelectionOflong |
場所 | ターゲットとなる場所の選択。 選択に格納されている値は、場所 ID を参照します。 足す: 随意。 既定値は null です。 更新: 随意 |
SelectionOflong |
RadiusTargets | マイル/キロメートルの観点から目的の地理的領域を表します。 足す: 随意。 既定値は null です。 更新: 随意 |
RadiusTarget 配列 |
要求ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
Authorization | Microsoft Advertising アカウントへのアクセス許可を持つユーザーの資格情報を表す OAuth アクセス トークン。 トークンのプレフィックスに "Bearer" があることを確認してください。これは、適切な認証に必要です。 詳細については、「 OAuth による認証」を参照してください。 |
string |
CustomerAccountId | 要求のエンティティを所有または関連付けられている広告アカウントの識別子。 両方が必要な場合、このヘッダー要素の値は AccountId 本文要素と同じである必要があります。 この要素は、ほとんどのサービス操作に必要であり、ベスト プラクティスとして常に設定する必要があります。 詳細については、「 アカウントと顧客 ID を取得する」を参照してください。 |
string |
CustomerId | ユーザーがアクセスまたは操作しているマネージャー アカウント (顧客) の識別子。 ユーザーは複数のマネージャー アカウントにアクセスできます。 この要素は、ほとんどのサービス操作に必要であり、ベスト プラクティスとして常に設定する必要があります。 詳細については、「 アカウントと顧客 ID を取得する」を参照してください。 |
string |
DeveloperToken | Bing Ads API へのアクセスに使用される開発者トークン。 詳細については、「 開発者トークンを取得する」を参照してください。 |
string |
Password | この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 | string |
UserName | この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 | string |
Response 要素
GetAudienceFullEstimationResponse オブジェクトは、サービス操作応答の本文とヘッダー要素を定義します。 要素は、 Response JSON に示されている順序と同じ順序で返されます。
応答本文の要素
要素 | 説明 | データ型 |
---|---|---|
通貨 |
DailyBudget と Bid の通貨。 null の場合、アカウント設定の通貨が使用されます。 足す: 随意。 既定値は null です。 更新: 随意 |
Currency |
EstAudienceSize | 四捨五入された結果を含む月間推定リーチ ユーザー数。 出力のみ。 | RangeResultOfDecimalRoundedResult |
EstClick | 範囲の結果を含む月間推定ユーザー数。 出力のみ。 | RangeResultOfDecimalRoundedResult |
EstCostPerEvent | イベントあたりの推定コストを示します。 フィールドの意味は、 CampaignBiddingStrategy 要求フィールドによって異なります。 出力のみ。 EnhancedCPC: CPC ManualCPM: CPM |
RangeResultOfDecimalRoundedResult |
EstCTR | 範囲の結果を含む推定クリックスルー率 (CTR)。 出力のみ。 | RangeResultOfdouble |
EstImpression | 範囲の結果を含む月間推定インプレッション数。 出力のみ。 | RangeResultOfDecimalRoundedResult |
EstReachAudienceSize | 範囲の結果を含む月間推定ユーザー数。 出力のみ。 | DecimalRoundedResult |
EstReachImpression | 範囲の結果を含む月間推定インプレッション数。 出力のみ。 | DecimalRoundedResult |
EstSpend | 範囲の結果を含む月間推定支出。 出力のみ。 | RangeResultOfDecimalRoundedResult |
EventsLostToBid | 入力入札が不十分なため、イベントが失われた回数を示します。 イベントの損失の種類は、 CampaignBiddingStrategy 要求フィールドによって異なります。 出力のみ。 EnhancedCPC: をクリックします。 ManualCPM: インプレッション |
int |
EventsLostToBudget | 入力予算が不十分なため、イベントの損失数を示します。 イベントの損失の種類は、 CampaignBiddingStrategy 要求フィールドによって異なります。 出力のみ。 EnhancedCPC: をクリックします。 ManualCPM: インプレッション |
int |
SuggestedBid | 現在のターゲティングで推奨される入札価格。 出力のみ。 | 小数 |
SuggestedBudget | 現在のターゲット設定と入札で推奨される 1 日の予算値。 出力のみ。 | 小数 |
応答ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
TrackingId | API 呼び出しの詳細を含むログ エントリの識別子。 | string |
JSON を要求する
このテンプレートは、JSON 要求の 本文 と ヘッダー 要素を表示するツールによって生成されました。 このサービス操作で使用できるサポートされる型については、上記の 要求本文要素 のリファレンスを参照してください。
{
"Age": {
"Excludes": [
"ValueHere"
],
"Includes": [
"ValueHere"
]
},
"Gender": {
"Excludes": [
"ValueHere"
],
"Includes": [
"ValueHere"
]
},
"Audience": {
"Excludes": [
"LongValueHere"
],
"Includes": [
"LongValueHere"
]
},
"Company": {
"Excludes": [
"LongValueHere"
],
"Includes": [
"LongValueHere"
]
},
"Industry": {
"Excludes": [
"LongValueHere"
],
"Includes": [
"LongValueHere"
]
},
"JobFunction": {
"Excludes": [
"LongValueHere"
],
"Includes": [
"LongValueHere"
]
},
"Location": {
"Excludes": [
"LongValueHere"
],
"Includes": [
"LongValueHere"
]
},
"RadiusTargets": [
{
"CenterLatitude": DoubleValueHere,
"CenterLongitude": DoubleValueHere,
"Radius": IntValueHere,
"RadiusUnit": "ValueHere"
}
],
"CampaignBiddingStrategy": IntValueHere,
"CampaignSubType": IntValueHere,
"Feed": {
"FeedId": "LongValueHere",
"FeedType": "LongValueHere",
"StoreId": "LongValueHere"
},
"DailyBudget": DecimalValueHere,
"Bid": DecimalValueHere,
"Currency": "ValueHere"
}
応答 JSON
このテンプレートは、JSON 応答の 本文 と ヘッダー 要素を表示するツールによって生成されました。
{
"EstImpression": {
"High": {
"Unit": "ValueHere",
"Value": DoubleValueHere
},
"Low": {
"Unit": "ValueHere",
"Value": DoubleValueHere
}
},
"EstAudienceSize": {
"High": {
"Unit": "ValueHere",
"Value": DoubleValueHere
},
"Low": {
"Unit": "ValueHere",
"Value": DoubleValueHere
}
},
"EstClick": {
"High": {
"Unit": "ValueHere",
"Value": DoubleValueHere
},
"Low": {
"Unit": "ValueHere",
"Value": DoubleValueHere
}
},
"EstSpend": {
"High": {
"Unit": "ValueHere",
"Value": DoubleValueHere
},
"Low": {
"Unit": "ValueHere",
"Value": DoubleValueHere
}
},
"EstCostPerEvent": {
"High": {
"Unit": "ValueHere",
"Value": DoubleValueHere
},
"Low": {
"Unit": "ValueHere",
"Value": DoubleValueHere
}
},
"EstCTR": {
"High": DoubleValueHere,
"Low": DoubleValueHere
},
"SuggestedBid": DecimalValueHere,
"SuggestedBudget": DecimalValueHere,
"EventsLostToBid": IntValueHere,
"EventsLostToBudget": IntValueHere,
"EstReachAudienceSize": {
"Unit": "ValueHere",
"Value": DoubleValueHere
},
"EstReachImpression": {
"Unit": "ValueHere",
"Value": DoubleValueHere
},
"Currency": "ValueHere"
}
コード構文
SDK を使用して REST API を呼び出すには、SDK を特定のバージョンにアップグレードし、システム パラメーターを構成する必要があります。構文の例は、 Bing広告 SDK で使用できます。 その他 の例については、「Bing広告 API コードの例 」を参照してください。
public async Task<GetAudienceFullEstimationResponse> GetAudienceFullEstimationAsync(
SelectionOfAgeEnum age,
SelectionOfGenderEnum gender,
SelectionOflong audience,
SelectionOflong company,
SelectionOflong industry,
SelectionOflong jobFunction,
SelectionOflong location,
IList<RadiusTarget> radiusTargets,
int? campaignBiddingStrategy,
int? campaignSubType,
Feed feed,
decimal? dailyBudget,
decimal? bid,
Currency? currency)
{
var request = new GetAudienceFullEstimationRequest
{
Age = age,
Gender = gender,
Audience = audience,
Company = company,
Industry = industry,
JobFunction = jobFunction,
Location = location,
RadiusTargets = radiusTargets,
CampaignBiddingStrategy = campaignBiddingStrategy,
CampaignSubType = campaignSubType,
Feed = feed,
DailyBudget = dailyBudget,
Bid = bid,
Currency = currency
};
return (await AdInsightService.CallAsync((s, r) => s.GetAudienceFullEstimationAsync(r), request));
}
static GetAudienceFullEstimationResponse getAudienceFullEstimation(
SelectionOfAgeEnum age,
SelectionOfGenderEnum gender,
SelectionOflong audience,
SelectionOflong company,
SelectionOflong industry,
SelectionOflong jobFunction,
SelectionOflong location,
ArrayOfRadiusTarget radiusTargets,
int campaignBiddingStrategy,
int campaignSubType,
Feed feed,
decimal dailyBudget,
decimal bid,
Currency currency) throws RemoteException, Exception
{
GetAudienceFullEstimationRequest request = new GetAudienceFullEstimationRequest();
request.setAge(age);
request.setGender(gender);
request.setAudience(audience);
request.setCompany(company);
request.setIndustry(industry);
request.setJobFunction(jobFunction);
request.setLocation(location);
request.setRadiusTargets(radiusTargets);
request.setCampaignBiddingStrategy(campaignBiddingStrategy);
request.setCampaignSubType(campaignSubType);
request.setFeed(feed);
request.setDailyBudget(dailyBudget);
request.setBid(bid);
request.setCurrency(currency);
return AdInsightService.getService().getAudienceFullEstimation(request);
}
static function GetAudienceFullEstimation(
$age,
$gender,
$audience,
$company,
$industry,
$jobFunction,
$location,
$radiusTargets,
$campaignBiddingStrategy,
$campaignSubType,
$feed,
$dailyBudget,
$bid,
$currency)
{
$GLOBALS['Proxy'] = $GLOBALS['AdInsightProxy'];
$request = new GetAudienceFullEstimationRequest();
$request->Age = $age;
$request->Gender = $gender;
$request->Audience = $audience;
$request->Company = $company;
$request->Industry = $industry;
$request->JobFunction = $jobFunction;
$request->Location = $location;
$request->RadiusTargets = $radiusTargets;
$request->CampaignBiddingStrategy = $campaignBiddingStrategy;
$request->CampaignSubType = $campaignSubType;
$request->Feed = $feed;
$request->DailyBudget = $dailyBudget;
$request->Bid = $bid;
$request->Currency = $currency;
return $GLOBALS['AdInsightProxy']->GetService()->GetAudienceFullEstimation($request);
}
response=adinsight_service.GetAudienceFullEstimation(
Age=Age,
Gender=Gender,
Audience=Audience,
Company=Company,
Industry=Industry,
JobFunction=JobFunction,
Location=Location,
RadiusTargets=RadiusTargets,
CampaignBiddingStrategy=CampaignBiddingStrategy,
CampaignSubType=CampaignSubType,
Feed=Feed,
DailyBudget=DailyBudget,
Bid=Bid,
Currency=Currency)