Opération de service GetGeoLocationsFileUrl - Gestion des campagnes
Obtient une URL temporaire que vous pouvez utiliser pour télécharger un fichier qui contient des identificateurs pour les emplacements géographiques que vous pouvez cibler ou exclure.
Pour plus d’informations sur le contenu du fichier, consultez Codes d’emplacement géographiques.
Éléments de demande
L’objet GetGeoLocationsFileUrlRequest définit les éléments body et header de la demande d’opération de service. Les éléments doivent être dans le même ordre que celui indiqué dans la requête SOAP.
Remarque
Sauf indication contraire ci-dessous, tous les éléments de requête sont requis.
Éléments du corps de la requête
| Élément | Description | Type de données |
|---|---|---|
| CompressionType | Définit les types de compression possibles pour le fichier à télécharger. Actuellement, le seul format de compression pris en charge est GZip. Cet élément de requête est facultatif. Si aucune valeur n’est transmise, l’API continue à retourner des fichiers non compressés. |
CompressionType |
| LanguageLocale | Langue et paramètres régionaux des noms d’affichage de l’emplacement géographique. Les valeurs de paramètres régionaux de langue prises en charge sont zh-Hant (chinois traditionnel), en (anglais), fr (français), de (allemand), it (italien), ja-JP (japonais), pt-BR (portugais brésilien) et es (espagnol). | chaîne |
| Version | Version du fichier d’emplacement que vous souhaitez télécharger. Actuellement, la seule version prise en charge est 2.0. |
chaîne |
Éléments d’en-tête de requête
| Élément | Description | Type de données |
|---|---|---|
| AuthenticationToken | Jeton d’accès OAuth qui représente les informations d’identification d’un utilisateur disposant d’autorisations sur les comptes Microsoft Advertising. Pour plus d’informations, consultez Authentification avec OAuth. |
chaîne |
| CustomerAccountId | Identificateur du compte publicitaire qui possède ou est associé aux entités dans la demande. Cet élément d’en-tête doit avoir la même valeur que l’élément de corps AccountId lorsque les deux sont nécessaires. Cet élément est requis pour la plupart des opérations de service et, à titre de bonne pratique, vous devez toujours le définir. Pour plus d’informations, consultez Obtenir votre compte et ID de client. |
chaîne |
| CustomerId | Identificateur du compte de responsable (client) auquel l’utilisateur accède ou à partir duquel il opère. Un utilisateur peut avoir accès à plusieurs comptes de gestionnaire. Cet élément est requis pour la plupart des opérations de service et, à titre de bonne pratique, vous devez toujours le définir. Pour plus d’informations, consultez Obtenir votre compte et ID de client. |
chaîne |
| DeveloperToken | Jeton de développeur utilisé pour accéder à l’API Bing Ads. Pour plus d’informations, consultez Obtenir un jeton de développeur. |
chaîne |
| Mot de passe | Cet élément est réservé à un usage interne et sera supprimé d’une version ultérieure de l’API. Vous devez utiliser l’élément AuthenticationToken pour définir les informations d’identification de l’utilisateur. | chaîne |
| UserName | Cet élément est réservé à un usage interne et sera supprimé d’une version ultérieure de l’API. Vous devez utiliser l’élément AuthenticationToken pour définir les informations d’identification de l’utilisateur. | chaîne |
Éléments Response
L’objet GetGeoLocationsFileUrlResponse définit les éléments body et header de la réponse de l’opération de service. Les éléments sont retournés dans le même ordre que celui indiqué dans la réponse SOAP.
Response Body, éléments
| Élément | Description | Type de données |
|---|---|---|
| FileUrl | URL de fichier que vous pouvez utiliser pour télécharger les données d’emplacement géographique pour la version, la langue et les paramètres régionaux que vous avez demandés. Avant de télécharger le fichier, case activée si la date et l’heure de l’élément LastModifiedTimeUtc sont postérieures à la date et à l’heure de votre téléchargement précédent. Vous devez uniquement télécharger le fichier si nécessaire. |
chaîne |
| FileUrlExpiryTimeUtc | Date et heure d’expiration de l’URL de fichier fournie. Si vous ne téléchargez pas le fichier avant l’heure d’expiration, vous pouvez appeler à nouveau l’opération pour demander une nouvelle URL de fichier. Vous pouvez observer que l’URL est définie pour expirer 15 minutes à partir de la fin de cette opération . Toutefois, vous ne devez pas dépendre d’une durée fixe. Les appels futurs à cette opération peuvent entraîner un délai d’expiration plus court ou plus long. La valeur est exprimée au format UTC (temps universel coordonné). La valeur de date et d’heure reflète la date et l’heure sur le serveur, et non le client. Pour plus d’informations sur le format de la date et de l’heure, consultez l’entrée dateTime dans Types de données XML primitifs. |
dateTime |
| LastModifiedTimeUtc | Date et heure de la dernière mise à jour des données d’emplacement géographique pour la version, la langue et les paramètres régionaux spécifiés. Il est recommandé de stocker cette date et cette heure, et ne téléchargez le fichier que si cette valeur est mise à jour à une date et une heure ultérieures. La valeur est exprimée au format UTC (temps universel coordonné). La valeur de date et d’heure reflète la date et l’heure sur le serveur, et non le client. Pour plus d’informations sur le format de la date et de l’heure, consultez l’entrée dateTime dans Types de données XML primitifs. |
dateTime |
Éléments d’en-tête de réponse
| Élément | Description | Type de données |
|---|---|---|
| TrackingId | Identificateur de l’entrée de journal qui contient les détails de l’appel d’API. | chaîne |
Requête SOAP
Ce modèle a été généré par un outil pour afficher l’ordre des éléments body et header pour la requête SOAP. Pour connaître les types pris en charge que vous pouvez utiliser avec cette opération de service, consultez la référence Éléments du corps de la demande ci-dessus.
<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/CampaignManagement/v13">
<Action mustUnderstand="1">GetGeoLocationsFileUrl</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>
<GetGeoLocationsFileUrlRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<Version i:nil="false">ValueHere</Version>
<LanguageLocale i:nil="false">ValueHere</LanguageLocale>
<CompressionType i:nil="false">ValueHere</CompressionType>
</GetGeoLocationsFileUrlRequest>
</s:Body>
</s:Envelope>
Soap de réponse
Ce modèle a été généré par un outil pour afficher l’ordre des éléments de corps et d’en-tête pour la réponse SOAP.
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
</s:Header>
<s:Body>
<GetGeoLocationsFileUrlResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<FileUrl d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</FileUrl>
<FileUrlExpiryTimeUtc d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</FileUrlExpiryTimeUtc>
<LastModifiedTimeUtc>ValueHere</LastModifiedTimeUtc>
</GetGeoLocationsFileUrlResponse>
</s:Body>
</s:Envelope>
Syntaxe du code
L’exemple de syntaxe peut être utilisé avec les Kits de développement logiciel (SDK) Bing Ads. Pour plus d’exemples, consultez Exemples de code de l’API Bing Ads .
public async Task<GetGeoLocationsFileUrlResponse> GetGeoLocationsFileUrlAsync(
string version,
string languageLocale,
CompressionType? compressionType)
{
var request = new GetGeoLocationsFileUrlRequest
{
Version = version,
LanguageLocale = languageLocale,
CompressionType = compressionType
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetGeoLocationsFileUrlAsync(r), request));
}
static GetGeoLocationsFileUrlResponse getGeoLocationsFileUrl(
java.lang.String version,
java.lang.String languageLocale,
CompressionType compressionType) throws RemoteException, Exception
{
GetGeoLocationsFileUrlRequest request = new GetGeoLocationsFileUrlRequest();
request.setVersion(version);
request.setLanguageLocale(languageLocale);
request.setCompressionType(compressionType);
return CampaignManagementService.getService().getGeoLocationsFileUrl(request);
}
static function GetGeoLocationsFileUrl(
$version,
$languageLocale,
$compressionType)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetGeoLocationsFileUrlRequest();
$request->Version = $version;
$request->LanguageLocale = $languageLocale;
$request->CompressionType = $compressionType;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetGeoLocationsFileUrl($request);
}
response=campaignmanagement_service.GetGeoLocationsFileUrl(
Version=Version,
LanguageLocale=LanguageLocale,
CompressionType=CompressionType)
Configuration requise
Service : CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13
URL de la demande
https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/GeoLocationsFileUrl/Query
Éléments de demande
L’objet GetGeoLocationsFileUrlRequest définit les éléments body et header de la demande d’opération de service.
Remarque
Sauf indication contraire ci-dessous, tous les éléments de requête sont requis.
Éléments du corps de la requête
| Élément | Description | Type de données |
|---|---|---|
| CompressionType | Définit les types de compression possibles pour le fichier à télécharger. Actuellement, le seul format de compression pris en charge est GZip. Cet élément de requête est facultatif. Si aucune valeur n’est transmise, l’API continue à retourner des fichiers non compressés. |
CompressionType |
| LanguageLocale | Langue et paramètres régionaux des noms d’affichage de l’emplacement géographique. Les valeurs de paramètres régionaux de langue prises en charge sont zh-Hant (chinois traditionnel), en (anglais), fr (français), de (allemand), it (italien), ja-JP (japonais), pt-BR (portugais brésilien) et es (espagnol). | chaîne |
| Version | Version du fichier d’emplacement que vous souhaitez télécharger. Actuellement, la seule version prise en charge est 2.0. |
chaîne |
Éléments d’en-tête de requête
| Élément | Description | Type de données |
|---|---|---|
| Autorisation | Jeton d’accès OAuth qui représente les informations d’identification d’un utilisateur disposant d’autorisations sur les comptes Microsoft Advertising. Vérifiez que le jeton est précédé de « Porteur », ce qui est nécessaire pour une authentification appropriée. Pour plus d’informations, consultez Authentification avec OAuth. |
chaîne |
| CustomerAccountId | Identificateur du compte publicitaire qui possède ou est associé aux entités dans la demande. Cet élément d’en-tête doit avoir la même valeur que l’élément de corps AccountId lorsque les deux sont nécessaires. Cet élément est requis pour la plupart des opérations de service et, à titre de bonne pratique, vous devez toujours le définir. Pour plus d’informations, consultez Obtenir votre compte et ID de client. |
chaîne |
| CustomerId | Identificateur du compte de responsable (client) auquel l’utilisateur accède ou à partir duquel il opère. Un utilisateur peut avoir accès à plusieurs comptes de gestionnaire. Cet élément est requis pour la plupart des opérations de service et, à titre de bonne pratique, vous devez toujours le définir. Pour plus d’informations, consultez Obtenir votre compte et ID de client. |
chaîne |
| DeveloperToken | Jeton de développeur utilisé pour accéder à l’API Bing Ads. Pour plus d’informations, consultez Obtenir un jeton de développeur. |
chaîne |
| Mot de passe | Cet élément est réservé à un usage interne et sera supprimé d’une version ultérieure de l’API. Vous devez utiliser l’élément AuthenticationToken pour définir les informations d’identification de l’utilisateur. | chaîne |
| UserName | Cet élément est réservé à un usage interne et sera supprimé d’une version ultérieure de l’API. Vous devez utiliser l’élément AuthenticationToken pour définir les informations d’identification de l’utilisateur. | chaîne |
Éléments Response
L’objet GetGeoLocationsFileUrlResponse définit les éléments body et header de la réponse de l’opération de service. Les éléments sont retournés dans le même ordre que celui indiqué dans le json de réponse.
Response Body, éléments
| Élément | Description | Type de données |
|---|---|---|
| FileUrl | URL de fichier que vous pouvez utiliser pour télécharger les données d’emplacement géographique pour la version, la langue et les paramètres régionaux que vous avez demandés. Avant de télécharger le fichier, case activée si la date et l’heure de l’élément LastModifiedTimeUtc sont postérieures à la date et à l’heure de votre téléchargement précédent. Vous devez uniquement télécharger le fichier si nécessaire. |
chaîne |
| FileUrlExpiryTimeUtc | Date et heure d’expiration de l’URL de fichier fournie. Si vous ne téléchargez pas le fichier avant l’heure d’expiration, vous pouvez appeler à nouveau l’opération pour demander une nouvelle URL de fichier. Vous pouvez observer que l’URL est définie pour expirer 15 minutes à partir de la fin de cette opération . Toutefois, vous ne devez pas dépendre d’une durée fixe. Les appels futurs à cette opération peuvent entraîner un délai d’expiration plus court ou plus long. La valeur est exprimée au format UTC (temps universel coordonné). La valeur de date et d’heure reflète la date et l’heure sur le serveur, et non le client. Pour plus d’informations sur le format de la date et de l’heure, consultez l’entrée dateTime dans Types de données XML primitifs. |
dateTime |
| LastModifiedTimeUtc | Date et heure de la dernière mise à jour des données d’emplacement géographique pour la version, la langue et les paramètres régionaux spécifiés. Il est recommandé de stocker cette date et cette heure, et ne téléchargez le fichier que si cette valeur est mise à jour à une date et une heure ultérieures. La valeur est exprimée au format UTC (temps universel coordonné). La valeur de date et d’heure reflète la date et l’heure sur le serveur, et non le client. Pour plus d’informations sur le format de la date et de l’heure, consultez l’entrée dateTime dans Types de données XML primitifs. |
dateTime |
Éléments d’en-tête de réponse
| Élément | Description | Type de données |
|---|---|---|
| TrackingId | Identificateur de l’entrée de journal qui contient les détails de l’appel d’API. | chaîne |
Requête JSON
Ce modèle a été généré par un outil pour afficher le corps et les éléments d’en-tête de la requête JSON. Pour connaître les types pris en charge que vous pouvez utiliser avec cette opération de service, consultez la référence Éléments du corps de la demande ci-dessus.
{
"Version": "ValueHere",
"LanguageLocale": "ValueHere",
"CompressionType": "ValueHere"
}
JSON de réponse
Ce modèle a été généré par un outil pour afficher le corps et les éléments d’en-tête de la réponse JSON.
{
"FileUrl": "ValueHere",
"FileUrlExpiryTimeUtc": "ValueHere",
"LastModifiedTimeUtc": "ValueHere"
}
Syntaxe du code
Pour appeler l’API REST via des kits SDK, vous devez mettre à niveau le KIT de développement logiciel (SDK) vers une certaine version et configurer les paramètres système. L’exemple de syntaxe peut être utilisé avec les Kits de développement logiciel (SDK) Bing Ads. Pour plus d’exemples, consultez Exemples de code de l’API Bing Ads .
public async Task<GetGeoLocationsFileUrlResponse> GetGeoLocationsFileUrlAsync(
string version,
string languageLocale,
CompressionType? compressionType)
{
var request = new GetGeoLocationsFileUrlRequest
{
Version = version,
LanguageLocale = languageLocale,
CompressionType = compressionType
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetGeoLocationsFileUrlAsync(r), request));
}
static GetGeoLocationsFileUrlResponse getGeoLocationsFileUrl(
java.lang.String version,
java.lang.String languageLocale,
CompressionType compressionType) throws RemoteException, Exception
{
GetGeoLocationsFileUrlRequest request = new GetGeoLocationsFileUrlRequest();
request.setVersion(version);
request.setLanguageLocale(languageLocale);
request.setCompressionType(compressionType);
return CampaignManagementService.getService().getGeoLocationsFileUrl(request);
}
static function GetGeoLocationsFileUrl(
$version,
$languageLocale,
$compressionType)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetGeoLocationsFileUrlRequest();
$request->Version = $version;
$request->LanguageLocale = $languageLocale;
$request->CompressionType = $compressionType;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetGeoLocationsFileUrl($request);
}
response=campaignmanagement_service.GetGeoLocationsFileUrl(
Version=Version,
LanguageLocale=LanguageLocale,
CompressionType=CompressionType)