האפליקציה הראשונה שלך: דרישות מוקדמות
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
לפני שתתחילו לתכנת את אפליקציית הלקוח הראשונה, כדאי לעשות כמה פעולות – אם עדיין לא עשיתם אותן.
יצירת חשבון Google וקבלת הרשאות ל-Search Ads 360
כדי להשתמש ב-Search Ads 360 API, צריך חשבון Google והרשאות מתאימות שהוקצו לחשבון הזה מ-Search Ads 360:
אם עדיין אין לך חשבון Google,
צריך ליצור חשבון.
אפשר לבקש ממנהל חשבון סוכנות ב-Search Ads 360
ליצור משתמש ב-Search Ads 360 לחשבון Google שלך.
כדי להוריד דוחות, תצטרכו הרשאת צפייה בחשבונות של המפרסמים שאיתם אתם עובדים.
כדי להוסיף או לערוך המרות, צריכה להיות לכם הרשאת עריכה בחשבונות המפרסמים שאיתם אתם עובדים. בהגדרה משותפת של Floodlight, צריכה להיות לכם הרשאת עריכה בכל חשבון צאצא של מפרסם שאליו אתם רוצים להעלות המרות.
לא צריך לתת לך הרשאת גישה לחשבון המפרסם הראשי, וגם לא לתת לך גישה לחשבונות של מפרסמים צאצאים שלא מעלים אליהם המרות. אם אתם משתמשים במספרי קליקים כדי לשייך המרות לביקורים, עליכם לוודא שיש לכם הרשאת עריכה בחשבון המפרסם שבו נוצר מספר הקליק. אם תציינו מספר קליק מחשבון מפרסם שאין לכם הרשאת עריכה אליו, הבקשה לא תעבוד.
מנהל הסוכנות יכול להגדיר את החשבון שלכם בתור משתמש מפרסם עם גישה למפרסמים ספציפיים, או להגדיר את החשבון עם רמת גישה גבוהה יותר, כמו משתמש סוכנות עם גישה לכל המפרסמים בסוכנות.
הפעלת שירות API ההמרות
אם רוצים להעלות נתונים על המרות, משתמש ב-Search Ads 360 עם הרשאות מנהל סוכנות צריך להיכנס לממשק המשתמש של Search Ads 360 ולהפעיל את שירות ההמרות של ה-API. ההוראות מפורטות במרכז העזרה של Search Ads 360.
יצירת פרויקט ב-Google API Console ופרטי כניסה ל-OAuth עבור הלקוח
- פותחים את
כלי ההגדרה של Google API Console.
כלי ההגדרה מנחה אתכם בתהליך יצירת הפרויקט (או שימוש בפרויקט קיים), הפעלת Search Ads 360 API ויצירת פרטי הכניסה ל-OAuth 2.0.
- בדף Register your application, בוחרים פרויקט קיים או לוחצים על Create a project. לאחר מכן, לוחצים על המשך.
- אחרי שמפעילים את Search Ads 360 API במסוף Google API, לוחצים על הלחצן Go to credentials.
- בדף Create credentials, מזינים את הפרטים הבאים:
-
באיזה ממשק API אתם משתמשים?: Search Ads 360 API
-
לאילו נתונים תהיה גישה? נתוני משתמשים
- לוחצים על הלחצן הבא.
כלי ההגדרה מציע עכשיו עזרה ביצירת מזהה לקוח OAuth 2.0.
- פועלים לפי שאר השלבים בכלי ההגדרה.
התקנה של sa360Api.py
מערכת Search Ads 360 מספקת סקריפט של כלי עזר שיעזור לכם בתהליך ההגדרה של
ההרשאה. אפשר להשתמש בסקריפט הזה גם כדי לשלוח ולקבל נתונים בפורמט JSON,
אם רוצים לנסות לשלוח ולקבל נתונים לפני שמתכננים וכותבים אפליקציה מלאה. אפשר להעתיק הרבה מהדוגמאות ל-JSON באתר העזרה הזה ולהזין אותן ישירות בסקריפט.
כדי להתקין את הסקריפט:
- מתקינים את Python 2.7.
הסקריפט לא פועל עם Python 3.x.
- מתקינים את cURL.
- מורידים את הקובץ sa360Api.zip.
- חילוץ של
sa360Api.py מ-sa360Api.zip.
- יצירת קובץ הפעלה
sa360Api.py.
העקרונות הבסיסיים של REST
יש שתי דרכים להפעיל את ה-API:
- שימוש בספריות לקוח.
- שליחה של בקשות HTTP וניתוח התגובות.
אם תחליטו לא להשתמש בספריות לקוח, תצטרכו להכיר את העקרונות הבסיסיים של REST.
REST הוא סגנון של ארכיטקטורת תוכנה שמציע תפיסה נוחה ועקבית לבקשת נתונים ולשינוי שלהם.
המונח REST הוא קיצור של Representational State Transfer. בהקשר של Google APIs, REST מתייחס לשימוש בפעלים של HTTP כדי לאחזר ולשנות ייצוגים של נתונים ש-Google מאחסנת.
במערכת RESTful, המשאבים מאוחסנים במאגר נתונים. לקוח שולח בקשה לשרת לבצע פעולה מסוימת (כמו יצירה, אחזור, עדכון או מחיקה של משאב), והשרת מבצע את הפעולה ושולח תגובה – לרוב בצורת ייצוג של המשאב שצוין.
בממשקי RESTful API של Google, הלקוח מציין פעולה באמצעות פועל של HTTP כמו POST, GET, PUT או DELETE. הוא מציין משאב לפי URI ייחודי גלובלי, באופן הבא:
https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters
מכיוון שלכל משאבי ה-API יש מזהה URI ייחודי שאפשר לגשת אליו באמצעות HTTP, ב-REST אפשר לשמור נתונים במטמון והוא מותאם לעבודה עם התשתית המבוזרת של האינטרנט.
תוכלו להיעזר בהגדרות השיטה במסמכי התיעוד של תקני HTTP 1.1 – הן כוללות מפרטים עבור GET, POST, PUT ו-DELETE.
REST ב-Search Ads 360 API
הפעולות של Search Ads 360 API ממופות ישירות לפעלים מסוג REST HTTP.
הפורמט הספציפי למזהי URI של Search Ads 360 API הוא:
https://www.googleapis.com/doubleclicksearch/v2/resourcePath?parameters
הקבוצה המלאה של מזהי ה-URI שמשמשים לכל פעולה נתמכת ב-API מסוכמת בחומר העזר של ה-API.
העקרונות הבסיסיים של JSON
אם משתמשים ב-REST, צריך להשתמש בפורמט JSON לגוף הבקשה. אפשר לציין שהתשובות יהיו בפורמט JSON או CSV.
JSON (JavaScript Object Notation) הוא פורמט נתונים נפוץ בלתי תלוי בשפה, שמספק ייצוג טקסט פשוט של מבני נתונים שרירותיים. למידע נוסף: json.org.
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2024-11-07 (שעון UTC).
[null,null,["עדכון אחרון: 2024-11-07 (שעון UTC)."],[[["\u003cp\u003eBefore using the Search Ads 360 API, ensure you have a Google Account with the necessary Search Ads 360 permissions, which may include view or edit access to specific advertisers.\u003c/p\u003e\n"],["\u003cp\u003eTo upload conversion data, the API Conversion Service must be activated by a Search Ads 360 user with Agency Manager privileges.\u003c/p\u003e\n"],["\u003cp\u003eSet up a Google API Console project and obtain OAuth credentials for your client application to authenticate and authorize API access.\u003c/p\u003e\n"],["\u003cp\u003eInstall the provided \u003ccode\u003esa360Api.py\u003c/code\u003e utility script and familiarize yourself with REST and JSON basics if you plan to interact with the API directly without client libraries.\u003c/p\u003e\n"]]],["To start coding, create a Google Account and request Search Ads 360 permissions from an Agency Manager, who will grant view or edit access to advertisers. Activate the API conversion service via the Search Ads 360 UI. Next, create a Google API Console project and OAuth 2.0 credentials. Install Python 2.7, cURL, and the `sa360Api.py` utility script. Finally, understand REST basics and JSON formatting, crucial for interacting with the API using HTTP requests.\n"],null,["# Your First App: Prerequisites\n\nBefore you can start coding your first client application, there are a few things you\nneed to do, if you haven't done them already.\n\nCreate a Google Account and get Search Ads 360 permissions\n----------------------------------------------------------\n\nTo use the Search Ads 360 API, you need a Google Account and appropriate permissions\ngranted to that account from Search Ads 360:\n\n1. If you don't already have a Google Account, [create one](https://support.google.com/accounts/answer/27441).\n\n2. Ask a Search Ads 360 **Agency Manager** to [create a Search Ads 360 user](https://support.google.com/searchads/answer/6051717) for your Google Account.\n\n To download reports, you'll need **view permission** for the advertisers\n you'll be working with.\n\n To add or edit conversions, you'll need **edit permission** for the advertisers\n you'll be working with. In a\n [shared Floodlight configuration](https://support.google.com/searchads/answer/2458167),\n you need edit permission for each child advertiser you want to upload conversions into.\n You don't need access to the parent advertiser, nor do you need access to child advertisers\n that you're not uploading conversions into. If you use click IDs to\n [attribute\n conversions to visits](/search-ads/v2/how-tos/conversions/insert#attribute-a-conversion-to-a-specific-visit), make sure you have edit access to the advertiser that generated\n the click ID. If you specify a click ID from an advertiser you don't have edit access to,\n the request will not succeed.\n\n The Agency Manager can set up your account as an **Advertiser user** with\n access to specific advertisers,\n or set up your account with a higher level of access such as **Agency user**\n with access to all advertisers in the agency.\n\nActivate the API Conversion Service\n-----------------------------------\n\n\nIf you want to upload data about conversions, a Search Ads 360 user with **Agency\nManager** privileges needs to sign in to the Search Ads 360 UI and\n**activate the API conversion service** . See the\n[Search Ads 360\nhelp center](https://support.google.com/searchads/answer/2604604#activate) for instructions.\n\nCreate a Google API Console project and OAuth credentials for your client\n-------------------------------------------------------------------------\n\n1. Start the Google API Console [setup tool](https://console.cloud.google.com/start/api?id=doubleclicksearch&credential=client_key). \n The setup tool guides you through creating a project (or using an existing project), enabling the Search Ads 360 API, and creating OAuth 2.0 credentials.\n2. On the **Register your application** page, select an existing project or select **Create a project** . Then click **Continue**.\n3. After the Google API Console enables the Search Ads 360 API, click the **Go to credentials** button.\n4. On the **Create credentials** page, enter the following information:\n - **Which API are you using?**: Search Ads 360 API\n - **What data will you be accessing?**: User data\n5. Click the **Next** button.\n\n The setup tool now offers to help you create an **OAuth 2.0 client ID**.\n6. Follow the rest of the steps in the setup tool.\n\nInstall sa360Api.py\n-------------------\n\nSearch Ads 360 provides a utility script to facilitate the process of setting up\nauthorization. You can also use this script to send and receive data in the JSON format,\nif you want to try sending and receiving data before you design and write a full\napplication. You can copy many of the JSON examples in this documentation site and input\nthem directly to the script.\n\nTo install the script:\n\n1. [Install Python](http://www.python.org/getit/) 2.7. \n The script does not work with Python 3.x.\n2. [Install cURL](http://curl.haxx.se/download.html).\n3. [Download sa360Api.zip](https://www.google.com/help/hc/downloads/sa360/sa360Api.zip).\n4. Extract `sa360Api.py` from `sa360Api.zip`.\n5. Make `sa360Api.py` executable.\n\nLearn REST basics\n-----------------\n\nThere are two ways to invoke the API:\n\n- Using [client libraries](/search-ads/v2/libraries).\n- Sending HTTP requests and parsing the responses.\n\nIf you decide not to use client libraries, you'll need to understand the basics of\nREST.\n\nREST is a style of software architecture that provides a convenient and consistent approach to requesting and modifying data.\n\nThe term REST is short for \"[Representational State Transfer](https://en.wikipedia.org/wiki/Representational_state_transfer).\" In the context of Google APIs, it refers to using HTTP verbs to retrieve and modify representations of data stored by Google.\n\nIn a RESTful system, resources are stored in a data store; a client sends a request that the server perform a particular action (such as creating, retrieving, updating, or deleting a resource), and the server performs the action and sends a response, often in the form of a representation of the specified resource.\n\nIn Google's RESTful APIs, the client specifies an action using an HTTP verb such as `POST`, `GET`, `PUT`, or `DELETE`. It specifies a resource by a globally-unique URI of the following form: \n\n```\nhttps://www.googleapis.com/apiName/apiVersion/resourcePath?parameters\n```\n\nBecause all API resources have unique HTTP-accessible URIs, REST enables data caching and is optimized to work with the web's distributed infrastructure.\n\nYou may find the [method definitions](https://tools.ietf.org/html/rfc7231#section-4.3) in the HTTP 1.1 standards documentation useful; they include specifications for `GET`, `POST`, `PUT`, and `DELETE`.\n\n### REST in the Search Ads 360 API\n\nThe Search Ads 360 API operations map directly to REST HTTP verbs.\n\nThe specific format for Search Ads 360 API URIs is: \n\n```\nhttps://www.googleapis.com/doubleclicksearch/v2/resourcePath?parameters\n```\n\n\nThe full set of URIs used for each supported operation in the API is summarized in the [API Reference](/search-ads/v2/reference).\n\nLearn JSON basics\n-----------------\n\nIf you use REST, you'll need to use the JSON format for the request bodies. You can\nspecify that the responses be either in the JSON or CSV format.\n\n\n[JSON](http://en.wikipedia.org/wiki/JSON) (JavaScript Object Notation) is a common, language-independent data format that provides a simple text representation of arbitrary data structures. For more information, see [json.org](http://www.json.org/).\n\n\u003cbr /\u003e"]]
