Operación del servicio GetProfileDataFileUrl: Administración de campañas
Obtiene una dirección URL temporal que puede usar para descargar datos de perfil de función de trabajo o del sector.
El archivo CSV descargado incluye identificadores de perfil que puede usar con ProfileCriterion.
Nota:
Puede usar la operación SearchCompanies para buscar datos de perfil por nombre de empresa.
Elementos Request
El objeto GetProfileDataFileUrlRequest define los elementos body y header de la solicitud de operación de servicio. Los elementos deben estar en el mismo orden que se muestra en la solicitud SOAP.
Nota:
A menos que se indique lo contrario a continuación, se requieren todos los elementos de solicitud.
Elementos del cuerpo de la solicitud
Elemento | Descripción | Tipo de datos |
---|---|---|
LanguageLocale | Idioma y configuración regional de los nombres para mostrar del perfil. Los valores de configuración regional del idioma admitidos son zh-Hant (chino tradicional), en (inglés), fr (francés), de (alemán), it (italiano), pt-BR (portugués brasileño) y es (español). Tenga en cuenta que si LinkedIn no proporciona el nombre del perfil localizado, el valor predeterminado será el nombre universal (normalmente definido en inglés). |
string |
ProfileType | Determina si desea datos de perfil de función de trabajo o del sector. El tipo de perfil CompanyName no se admite para esta operación de servicio. Puede usar la operación SearchCompanies para buscar datos de perfil por nombre de empresa. |
ProfileType |
Elementos de encabezado de solicitud
Elemento | Descripción | Tipo de datos |
---|---|---|
AuthenticationToken | Token de acceso de OAuth que representa las credenciales de un usuario que tiene permisos para cuentas de Microsoft Advertising. Para obtener más información, consulte Autenticación con OAuth. |
string |
CustomerAccountId | Identificador de la cuenta de anuncio que posee o está asociada a las entidades de la solicitud. Este elemento de encabezado debe tener el mismo valor que el elemento de cuerpo AccountId cuando ambos son necesarios. Este elemento es necesario para la mayoría de las operaciones de servicio y, como procedimiento recomendado, siempre debe establecerlo. Para obtener más información, consulte Obtención de su cuenta e identificadores de cliente. |
string |
CustomerId | Identificador de la cuenta de administrador (cliente) desde la que el usuario accede o funciona. Un usuario puede tener acceso a varias cuentas de administrador. Este elemento es necesario para la mayoría de las operaciones de servicio y, como procedimiento recomendado, siempre debe establecerlo. Para obtener más información, consulte Obtención de su cuenta e identificadores de cliente. |
string |
DeveloperToken | Token de desarrollador que se usa para acceder a Bing Ads API. Para obtener más información, consulte Obtención de un token de desarrollador. |
string |
Password | Este elemento está reservado para uso interno y se quitará de una versión futura de la API. Debe usar el elemento AuthenticationToken para establecer las credenciales de usuario. | string |
UserName | Este elemento está reservado para uso interno y se quitará de una versión futura de la API. Debe usar el elemento AuthenticationToken para establecer las credenciales de usuario. | string |
Elementos de respuesta
El objeto GetProfileDataFileUrlResponse define los elementos body y header de la respuesta de la operación de servicio. Los elementos se devuelven en el mismo orden que se muestra en soap de respuesta.
Elementos del cuerpo de la respuesta
Elemento | Descripción | Tipo de datos |
---|---|---|
FileUrl | Dirección URL del archivo que puede usar para descargar los datos de perfil para el tipo de perfil, el idioma y la configuración regional que solicitó. Antes de descargar el archivo, compruebe si la fecha y hora del elemento LastModifiedTimeUtc es posterior a la fecha y hora de la descarga anterior. Solo debe descargar el archivo si es necesario. |
string |
FileUrlExpiryTimeUtc | Fecha y hora en que expirará la dirección URL del archivo proporcionada. Si no descarga el archivo antes de la hora de expiración, puede volver a llamar a la operación para solicitar una nueva dirección URL de archivo. Puede observar que la dirección URL está establecida para expirar 15 minutos a partir del momento en que se complete esta operación; sin embargo, no debe depender de una duración fija. Las llamadas futuras a esta operación pueden dar lugar a un tiempo de expiración más corto o más largo. El valor se encuentra en la hora UTC (hora universal coordinada). El valor de fecha y hora refleja la fecha y hora en el servidor, no en el cliente. Para obtener información sobre el formato de la fecha y hora, vea la entrada dateTime en Tipos de datos XML primitivos. |
dateTime |
LastModifiedTimeUtc | Fecha y hora en que se actualizaron por última vez los datos de perfil para el tipo de perfil, el idioma y la configuración regional. Como procedimiento recomendado, debe almacenar esta fecha y hora y, en adelante, descargar solo el archivo si este valor se actualiza a una fecha y hora posteriores. El valor se encuentra en la hora UTC (hora universal coordinada). El valor de fecha y hora refleja la fecha y hora en el servidor, no en el cliente. Para obtener información sobre el formato de la fecha y hora, vea la entrada dateTime en Tipos de datos XML primitivos. |
dateTime |
Elementos de encabezado de respuesta
Elemento | Descripción | Tipo de datos |
---|---|---|
Seguimiento del Id. | Identificador de la entrada de registro que contiene los detalles de la llamada API. | string |
Solicitud de SOAP
Esta plantilla se generó mediante una herramienta para mostrar el orden del cuerpo y los elementos de encabezado de la solicitud SOAP. Para ver los tipos admitidos que puede usar con esta operación de servicio, consulte la referencia de elementos de cuerpo de solicitud anterior.
<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">GetProfileDataFileUrl</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>
<GetProfileDataFileUrlRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<LanguageLocale i:nil="false">ValueHere</LanguageLocale>
<ProfileType>ValueHere</ProfileType>
</GetProfileDataFileUrlRequest>
</s:Body>
</s:Envelope>
SOAP de respuesta
Esta plantilla se generó mediante una herramienta para mostrar el orden de los elementos body y header para la respuesta 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>
<GetProfileDataFileUrlResponse 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>
</GetProfileDataFileUrlResponse>
</s:Body>
</s:Envelope>
Sintaxis de código
La sintaxis de ejemplo se puede usar con los SDK de Bing Ads. Consulte Ejemplos de código de API de Bing Ads para obtener más ejemplos.
public async Task<GetProfileDataFileUrlResponse> GetProfileDataFileUrlAsync(
string languageLocale,
ProfileType profileType)
{
var request = new GetProfileDataFileUrlRequest
{
LanguageLocale = languageLocale,
ProfileType = profileType
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetProfileDataFileUrlAsync(r), request));
}
static GetProfileDataFileUrlResponse getProfileDataFileUrl(
java.lang.String languageLocale,
ArrayList<ProfileType> profileType) throws RemoteException, Exception
{
GetProfileDataFileUrlRequest request = new GetProfileDataFileUrlRequest();
request.setLanguageLocale(languageLocale);
request.setProfileType(profileType);
return CampaignManagementService.getService().getProfileDataFileUrl(request);
}
static function GetProfileDataFileUrl(
$languageLocale,
$profileType)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetProfileDataFileUrlRequest();
$request->LanguageLocale = $languageLocale;
$request->ProfileType = $profileType;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetProfileDataFileUrl($request);
}
response=campaignmanagement_service.GetProfileDataFileUrl(
LanguageLocale=LanguageLocale,
ProfileType=ProfileType)
Requisitos
Servicio: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13
Dirección URL de solicitud
https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/ProfileDataFileUrl/Query
Elementos Request
El objeto GetProfileDataFileUrlRequest define los elementos body y header de la solicitud de operación de servicio.
Nota:
A menos que se indique lo contrario a continuación, se requieren todos los elementos de solicitud.
Elementos del cuerpo de la solicitud
Elemento | Descripción | Tipo de datos |
---|---|---|
LanguageLocale | Idioma y configuración regional de los nombres para mostrar del perfil. Los valores de configuración regional del idioma admitidos son zh-Hant (chino tradicional), en (inglés), fr (francés), de (alemán), it (italiano), pt-BR (portugués brasileño) y es (español). Tenga en cuenta que si LinkedIn no proporciona el nombre del perfil localizado, el valor predeterminado será el nombre universal (normalmente definido en inglés). |
string |
ProfileType | Determina si desea datos de perfil de función de trabajo o del sector. El tipo de perfil CompanyName no se admite para esta operación de servicio. Puede usar la operación SearchCompanies para buscar datos de perfil por nombre de empresa. |
ProfileType |
Elementos de encabezado de solicitud
Elemento | Descripción | Tipo de datos |
---|---|---|
Autorización | Token de acceso de OAuth que representa las credenciales de un usuario que tiene permisos para cuentas de Microsoft Advertising. Asegúrese de que el token tiene el prefijo "Portador", esto es necesario para la autenticación adecuada. Para obtener más información, consulte Autenticación con OAuth. |
string |
CustomerAccountId | Identificador de la cuenta de anuncio que posee o está asociada a las entidades de la solicitud. Este elemento de encabezado debe tener el mismo valor que el elemento de cuerpo AccountId cuando ambos son necesarios. Este elemento es necesario para la mayoría de las operaciones de servicio y, como procedimiento recomendado, siempre debe establecerlo. Para obtener más información, consulte Obtención de su cuenta e identificadores de cliente. |
string |
CustomerId | Identificador de la cuenta de administrador (cliente) desde la que el usuario accede o funciona. Un usuario puede tener acceso a varias cuentas de administrador. Este elemento es necesario para la mayoría de las operaciones de servicio y, como procedimiento recomendado, siempre debe establecerlo. Para obtener más información, consulte Obtención de su cuenta e identificadores de cliente. |
string |
DeveloperToken | Token de desarrollador que se usa para acceder a Bing Ads API. Para obtener más información, consulte Obtención de un token de desarrollador. |
string |
Password | Este elemento está reservado para uso interno y se quitará de una versión futura de la API. Debe usar el elemento AuthenticationToken para establecer las credenciales de usuario. | string |
UserName | Este elemento está reservado para uso interno y se quitará de una versión futura de la API. Debe usar el elemento AuthenticationToken para establecer las credenciales de usuario. | string |
Elementos de respuesta
El objeto GetProfileDataFileUrlResponse define los elementos body y header de la respuesta de la operación de servicio. Los elementos se devuelven en el mismo orden que se muestra en el JSON de respuesta.
Elementos del cuerpo de la respuesta
Elemento | Descripción | Tipo de datos |
---|---|---|
FileUrl | Dirección URL del archivo que puede usar para descargar los datos de perfil para el tipo de perfil, el idioma y la configuración regional que solicitó. Antes de descargar el archivo, compruebe si la fecha y hora del elemento LastModifiedTimeUtc es posterior a la fecha y hora de la descarga anterior. Solo debe descargar el archivo si es necesario. |
string |
FileUrlExpiryTimeUtc | Fecha y hora en que expirará la dirección URL del archivo proporcionada. Si no descarga el archivo antes de la hora de expiración, puede volver a llamar a la operación para solicitar una nueva dirección URL de archivo. Puede observar que la dirección URL está establecida para expirar 15 minutos a partir del momento en que se complete esta operación; sin embargo, no debe depender de una duración fija. Las llamadas futuras a esta operación pueden dar lugar a un tiempo de expiración más corto o más largo. El valor se encuentra en la hora UTC (hora universal coordinada). El valor de fecha y hora refleja la fecha y hora en el servidor, no en el cliente. Para obtener información sobre el formato de la fecha y hora, vea la entrada dateTime en Tipos de datos XML primitivos. |
dateTime |
LastModifiedTimeUtc | Fecha y hora en que se actualizaron por última vez los datos de perfil para el tipo de perfil, el idioma y la configuración regional. Como procedimiento recomendado, debe almacenar esta fecha y hora y, en adelante, descargar solo el archivo si este valor se actualiza a una fecha y hora posteriores. El valor se encuentra en la hora UTC (hora universal coordinada). El valor de fecha y hora refleja la fecha y hora en el servidor, no en el cliente. Para obtener información sobre el formato de la fecha y hora, vea la entrada dateTime en Tipos de datos XML primitivos. |
dateTime |
Elementos de encabezado de respuesta
Elemento | Descripción | Tipo de datos |
---|---|---|
Seguimiento del Id. | Identificador de la entrada de registro que contiene los detalles de la llamada API. | string |
Solicitud de JSON
Esta plantilla se generó mediante una herramienta para mostrar los elementos body y header de la solicitud JSON. Para ver los tipos admitidos que puede usar con esta operación de servicio, consulte la referencia de elementos de cuerpo de solicitud anterior.
{
"LanguageLocale": "ValueHere",
"ProfileType": "ValueHere"
}
JSON de respuesta
Esta plantilla se generó mediante una herramienta para mostrar los elementos body y header de la respuesta JSON.
{
"FileUrl": "ValueHere",
"FileUrlExpiryTimeUtc": "ValueHere",
"LastModifiedTimeUtc": "ValueHere"
}
Sintaxis de código
Para llamar a la API REST a través de SDK, debe actualizar el SDK a una versión determinada y configurar los parámetros del sistema. La sintaxis de ejemplo se puede usar con los SDK de Bing Ads. Consulte Ejemplos de código de API de Bing Ads para obtener más ejemplos.
public async Task<GetProfileDataFileUrlResponse> GetProfileDataFileUrlAsync(
string languageLocale,
ProfileType profileType)
{
var request = new GetProfileDataFileUrlRequest
{
LanguageLocale = languageLocale,
ProfileType = profileType
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetProfileDataFileUrlAsync(r), request));
}
static GetProfileDataFileUrlResponse getProfileDataFileUrl(
java.lang.String languageLocale,
ArrayList<ProfileType> profileType) throws RemoteException, Exception
{
GetProfileDataFileUrlRequest request = new GetProfileDataFileUrlRequest();
request.setLanguageLocale(languageLocale);
request.setProfileType(profileType);
return CampaignManagementService.getService().getProfileDataFileUrl(request);
}
static function GetProfileDataFileUrl(
$languageLocale,
$profileType)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetProfileDataFileUrlRequest();
$request->LanguageLocale = $languageLocale;
$request->ProfileType = $profileType;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetProfileDataFileUrl($request);
}
response=campaignmanagement_service.GetProfileDataFileUrl(
LanguageLocale=LanguageLocale,
ProfileType=ProfileType)